rte_osadapter_socket.h

Go to the documentation of this file.

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

#define RTE_OS_SOCKET_INVALID_HANDLE ((intptr_t)(-1))

typedef intptr_t rte_os_socket_handle_t;

typedef enum rte_os_socket_type_e
{
    RTE_OS_SOCKET_TYPE_UDP = 1, 
    RTE_OS_SOCKET_TYPE_TCP = 2  
} rte_os_socket_type_t;

typedef enum rte_os_socket_event_e
{
    RTE_OS_SOCKET_EVENT_READ  = 1U, 
    RTE_OS_SOCKET_EVENT_WRITE = 2U, 
    RTE_OS_SOCKET_EVENT_ERROR = 4U  
} rte_os_socket_event_t;

typedef struct rte_os_socket_ops_s
{
    rte_status_t (*open)(rte_os_socket_type_t type, rte_os_socket_handle_t *out_handle);

    rte_status_t (*bind)(rte_os_socket_handle_t handle, const char *host, uint16_t port);

    rte_status_t (*connect)(rte_os_socket_handle_t handle, const char *host, uint16_t port);

    rte_status_t (*send)(rte_os_socket_handle_t handle, const void *buf, size_t len, size_t *out_sent);

    rte_status_t (*sendto)(rte_os_socket_handle_t handle, const void *buf, size_t len,
                            const char *host, uint16_t port, size_t *out_sent);

    rte_status_t (*recv)(rte_os_socket_handle_t handle, void *buf, size_t len, size_t *out_recv);

    rte_status_t (*recvfrom)(rte_os_socket_handle_t handle, void *buf, size_t len,
                              char *out_host, size_t host_len, uint16_t *out_port, size_t *out_recv);

    rte_status_t (*poll)(rte_os_socket_handle_t handle, uint32_t events,
                          rte_duration_ms_t timeout_ms, uint32_t *out_revents);

    rte_status_t (*set_nonblocking)(rte_os_socket_handle_t handle, bool nonblocking);

    rte_status_t (*close)(rte_os_socket_handle_t handle);
 
} rte_os_socket_ops_t;

rte_status_t rte_osadapter_register_socket_ops(const rte_os_socket_ops_t *ops);

const rte_os_socket_ops_t *rte_osadapter_get_socket_ops(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OSADAPTER_SOCKET_H */