result.h

Go to the documentation of this file.

#pragma once
 
 
#include "connect.h"
 
#include <limits.h>
#include <stdalign.h>
#include <stddef.h>
 
 
typedef union udipe_network_payload_u {
    udipe_connect_result_t connect;  
    udipe_disconnect_result_t disconnect;  
    // TODO: Add and implement
    /*udipe_send_result_t send;  ///< Result of udipe_send()
    udipe_recv_result_t recv;  ///< Result of udipe_recv()*/
} udipe_network_payload_t;
 
typedef struct udipe_custom_payload_s {
    alignas(void*) char bytes[2*sizeof(void*)];
} udipe_custom_payload_t;
 
// Forward declaration of \ref udipe_future_t
typedef struct udipe_future_s udipe_future_t;
 
typedef struct udipe_unordered_payload_s {
    size_t ready_idx;
 
    udipe_future_t* next;
} udipe_unordered_payload_t;
 
typedef struct udipe_timer_repeat_payload_s {
    size_t missed_ticks;
 
    udipe_future_t* next;
} udipe_timer_repeat_payload_t;
 
typedef enum udipe_result_type_e {
    // TODO describe associated payload types
    UDIPE_CONNECT = 1,  
    UDIPE_DISCONNECT,  
    // TODO: Add and implement
    /*UDIPE_SEND,  ///< udipe_start_send()
    UDIPE_RECV,  ///< udipe_start_recv()*/
    UDIPE_CUSTOM, 
    UDIPE_JOIN,  
    UDIPE_UNORDERED, 
    UDIPE_TIMER_ONCE, 
    UDIPE_TIMER_REPEAT, 
 
    UDIPE_RESULT_INVALID = 0,
 
    UDIPE_FAILURE_DEPENDENCY = INT_MIN,
 
    UDIPE_FAILURE_CANCELED,
 
    // You will notice that there is no `UDIPE_FAILURE_INTERNAL` or
    // `UDIPE_FAILURE_SELF` result type for errors that originate from the
    // operation itself. That is because such errors are not reported via the
    // result type code, but instead encoded within a normal result payload.
    //
    // This way, error types do not need to be generic over all operation types
    // supported by udipe, they can be specific to each individual operation
    // type and only cover the error categories that are actually relevant to
    // the operation of interest.
} udipe_result_type_t;
 
typedef struct udipe_result_s {
    union {
        // TODO doc
        udipe_network_payload_t network;
        // TODO doc
        udipe_custom_payload_t custom;
        // TODO doc
        udipe_unordered_payload_t unordered;
        // TODO doc
        udipe_timer_repeat_payload_t timer_repeat;
    } payload;
 
    udipe_result_type_t type;
} udipe_result_t;