rte_protocol_adapter.h

Go to the documentation of this file.

#ifndef RTE_PROTOCOL_ADAPTER_H
#define RTE_PROTOCOL_ADAPTER_H
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
#include "rte_osadapter/rte_osadapter_socket.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_PROTOCOL_ENDPOINT_STR_MAX (64U)

typedef enum rte_protocol_type_e
{
    RTE_PROTOCOL_TYPE_RAW_UDP = 1, 
    RTE_PROTOCOL_TYPE_RAW_TCP = 2, 
    RTE_PROTOCOL_TYPE_DDS     = 3  
} rte_protocol_type_t;

typedef enum rte_protocol_role_e
{
    RTE_PROTOCOL_ROLE_LISTEN  = 1, 
    RTE_PROTOCOL_ROLE_CONNECT = 2, 
    RTE_PROTOCOL_ROLE_PUB     = 3, 
    RTE_PROTOCOL_ROLE_SUB     = 4  
} rte_protocol_role_t;

typedef struct rte_protocol_config_s
{
    rte_protocol_type_t protocol_type;
    rte_protocol_role_t role;

    char host[RTE_PROTOCOL_ENDPOINT_STR_MAX];

    uint16_t port;

    char topic[RTE_PROTOCOL_ENDPOINT_STR_MAX];

    uint32_t domain_id;

    size_t max_message_size;

    rte_duration_ms_t open_timeout_ms;

    rte_duration_ms_t default_timeout_ms;

    bool use_handshake;
} rte_protocol_config_t;

typedef struct rte_protocol_impl_s *rte_protocol_handle_t;

typedef struct rte_protocol_adapter_ops_s
{
    rte_status_t (*open)(void *storage, size_t storage_size,
                          const rte_protocol_config_t *config,
                          const rte_os_socket_ops_t *os_sockets,
                          rte_protocol_handle_t *out_handle);

    rte_status_t (*send)(rte_protocol_handle_t handle, const void *data,
                          size_t size, rte_duration_ms_t timeout_ms);

    rte_status_t (*receive)(rte_protocol_handle_t handle, void *out_buf,
                             size_t buffer_size, rte_duration_ms_t timeout_ms);

    rte_status_t (*close)(rte_protocol_handle_t handle);
 
} rte_protocol_adapter_ops_t;

rte_status_t rte_protocol_adapter_register(rte_protocol_type_t type,
                                             const rte_protocol_adapter_ops_t *ops);

const rte_protocol_adapter_ops_t *rte_protocol_adapter_get(rte_protocol_type_t type);

const rte_protocol_adapter_ops_t *rte_protocol_adapter_get_udp(void);

const rte_protocol_adapter_ops_t *rte_protocol_adapter_get_tcp(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_PROTOCOL_ADAPTER_H */