Skip to content

File socket.h

Headers > cais > socket.h

Go to the source code of this file

  • #include <stddef.h>
  • #include <cais/types.h>

Data Structures

Type Name
struct cais_pollfd_t
Polling descriptor structure for multi-socket event multiplexing.

Types

Type Name
enum cais_socket_event_t
enum cais_socket_mode_t
typedef struct cais_socket cais_socket_t
enum cais_socket_type_t

Functions

Type Name
cais_socket_t * cais_socket_accept (cais_socket_t * server, char * client_ip, size_t ip_len, int * client_port, char * err_buf, size_t err_cap)
cais_socket_t * cais_socket_bind (const char * host, int port, int backlog, cais_socket_mode_t mode, char * err_buf, size_t err_cap)
cais_socket_status_t cais_socket_bind_sock (cais_socket_t * sock, const char * host, int port, int backlog, char * err_buf, size_t err_cap)
void cais_socket_close (cais_socket_t * sock)
cais_socket_t * cais_socket_connect (const char * host, int port, cais_socket_mode_t mode, char * err_buf, size_t err_cap)
cais_socket_status_t cais_socket_connect_sock (cais_socket_t * sock, const char * host, int port, char * err_buf, size_t err_cap)
cais_socket_t * cais_socket_create (cais_socket_type_t type, cais_socket_mode_t mode, char * err_buf, size_t err_cap)
int cais_socket_get_fd (const cais_socket_t * sock)
cais_socket_mode_t cais_socket_get_mode (const cais_socket_t * sock)
cais_socket_type_t cais_socket_get_type (const cais_socket_t * sock)
cais_bool_t cais_socket_is_blocking (const cais_socket_t * sock)
cais_bool_t cais_socket_is_nonblocking (const cais_socket_t * sock)
int cais_socket_poll (cais_pollfd_t * fds, size_t nfds, int timeout_ms)
cais_socket_status_t cais_socket_read (cais_socket_t * sock, char * buf, size_t max_len, size_t * received)
cais_socket_status_t cais_socket_recv (cais_socket_t * sock, char * buf, size_t max_len, size_t * received)
cais_socket_status_t cais_socket_recvfrom (cais_socket_t * sock, char * buf, size_t max_len, char * src_ip, size_t ip_len, int * src_port, size_t * received)
cais_socket_status_t cais_socket_send (cais_socket_t * sock, const char * buf, size_t len, size_t * sent)
cais_socket_status_t cais_socket_sendto (cais_socket_t * sock, const char * buf, size_t len, const char * host, int port, size_t * sent)
cais_socket_status_t cais_socket_set_mode (cais_socket_t * sock, cais_socket_mode_t mode, char * err_buf, size_t err_cap)
cais_socket_status_t cais_socket_set_timeout (cais_socket_t * sock, int timeout_ms, char * err_buf, size_t err_cap)
cais_socket_t * cais_socket_tcp (cais_socket_mode_t mode, char * err_buf, size_t err_cap)
cais_socket_t * cais_socket_udp (cais_socket_mode_t mode, char * err_buf, size_t err_cap)
cais_socket_t * cais_socket_udp_bind (const char * host, int port, cais_socket_mode_t mode, char * err_buf, size_t err_cap)
int cais_socket_wait (cais_socket_t * sock, int events, int timeout_ms)
cais_socket_status_t cais_socket_write (cais_socket_t * sock, const char * buf, size_t len, size_t * sent)

Macros

Type Name
define CAIS_SOCK_DGRAM CAIS\_SOCK\_UDP
define CAIS_SOCK_STREAM CAIS\_SOCK\_TCP

Type Details

enum cais_socket_event_t

enum cais_socket_event_t {
    CAIS_SOCK_POLL_READ = 1 << 0,
    CAIS_SOCK_POLL_WRITE = 1 << 1,
    CAIS_SOCK_POLL_ERR = 1 << 2
};

enum cais_socket_mode_t

enum cais_socket_mode_t {
    CAIS_SOCK_BLOCKING = 0,
    CAIS_SOCK_NONBLOCKING = 1
};

cais_socket_t

typedef struct cais_socket cais_socket_t;

enum cais_socket_type_t

enum cais_socket_type_t {
    CAIS_SOCK_TCP = 1,
    CAIS_SOCK_UDP = 2
};

Function Details

cais_socket_accept

cais_socket_t * cais_socket_accept (
    cais_socket_t * server,
    char * client_ip,
    size_t ip_len,
    int * client_port,
    char * err_buf,
    size_t err_cap
) 

cais_socket_bind

cais_socket_t * cais_socket_bind (
    const char * host,
    int port,
    int backlog,
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_bind_sock

cais_socket_status_t cais_socket_bind_sock (
    cais_socket_t * sock,
    const char * host,
    int port,
    int backlog,
    char * err_buf,
    size_t err_cap
) 

cais_socket_close

void cais_socket_close (
    cais_socket_t * sock
) 

cais_socket_connect

cais_socket_t * cais_socket_connect (
    const char * host,
    int port,
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_connect_sock

cais_socket_status_t cais_socket_connect_sock (
    cais_socket_t * sock,
    const char * host,
    int port,
    char * err_buf,
    size_t err_cap
) 

cais_socket_create

cais_socket_t * cais_socket_create (
    cais_socket_type_t type,
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_get_fd

int cais_socket_get_fd (
    const cais_socket_t * sock
) 

cais_socket_get_mode

cais_socket_mode_t cais_socket_get_mode (
    const cais_socket_t * sock
) 

cais_socket_get_type

cais_socket_type_t cais_socket_get_type (
    const cais_socket_t * sock
) 

cais_socket_is_blocking

cais_bool_t cais_socket_is_blocking (
    const cais_socket_t * sock
) 

cais_socket_is_nonblocking

cais_bool_t cais_socket_is_nonblocking (
    const cais_socket_t * sock
) 

cais_socket_poll

int cais_socket_poll (
    cais_pollfd_t * fds,
    size_t nfds,
    int timeout_ms
) 

cais_socket_read

cais_socket_status_t cais_socket_read (
    cais_socket_t * sock,
    char * buf,
    size_t max_len,
    size_t * received
) 

cais_socket_recv

cais_socket_status_t cais_socket_recv (
    cais_socket_t * sock,
    char * buf,
    size_t max_len,
    size_t * received
) 

cais_socket_recvfrom

cais_socket_status_t cais_socket_recvfrom (
    cais_socket_t * sock,
    char * buf,
    size_t max_len,
    char * src_ip,
    size_t ip_len,
    int * src_port,
    size_t * received
) 

cais_socket_send

cais_socket_status_t cais_socket_send (
    cais_socket_t * sock,
    const char * buf,
    size_t len,
    size_t * sent
) 

cais_socket_sendto

cais_socket_status_t cais_socket_sendto (
    cais_socket_t * sock,
    const char * buf,
    size_t len,
    const char * host,
    int port,
    size_t * sent
) 

cais_socket_set_mode

cais_socket_status_t cais_socket_set_mode (
    cais_socket_t * sock,
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_set_timeout

cais_socket_status_t cais_socket_set_timeout (
    cais_socket_t * sock,
    int timeout_ms,
    char * err_buf,
    size_t err_cap
) 

cais_socket_tcp

cais_socket_t * cais_socket_tcp (
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_udp

cais_socket_t * cais_socket_udp (
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_udp_bind

cais_socket_t * cais_socket_udp_bind (
    const char * host,
    int port,
    cais_socket_mode_t mode,
    char * err_buf,
    size_t err_cap
) 

cais_socket_wait

int cais_socket_wait (
    cais_socket_t * sock,
    int events,
    int timeout_ms
) 

cais_socket_write

cais_socket_status_t cais_socket_write (
    cais_socket_t * sock,
    const char * buf,
    size_t len,
    size_t * sent
) 

Macro Details

CAIS_SOCK_DGRAM

#define CAIS_SOCK_DGRAM `CAIS_SOCK_UDP`

CAIS_SOCK_STREAM

#define CAIS_SOCK_STREAM `CAIS_SOCK_TCP`


The documentation was generated from the following file: include/cais/socket.h