libcoap 4.3.3
coap_io.c File Reference

Network I/O functions. More...

+ Include dependency graph for coap_io.c:

Go to the source code of this file.

Data Structures

struct  in6_pktinfo
 
struct  in_pktinfo
 

Macros

#define MSG_NOSIGNAL   0
 
#define SOL_IP   IPPROTO_IP
 
#define COAP_SOL_IP   SOL_IP
 
#define iov_len_t   size_t
 
#define SIN6(A)   ((struct sockaddr_in6 *)(A))
 

Functions

int coap_socket_bind_udp (coap_socket_t *sock, const coap_address_t *listen_addr, coap_address_t *bound_addr)
 
void coap_socket_close (coap_socket_t *sock)
 Function interface to close off a socket. More...
 
ssize_t coap_socket_write (coap_socket_t *sock, const uint8_t *data, size_t data_len)
 Function interface for data stream sending off a socket. More...
 
ssize_t coap_socket_read (coap_socket_t *sock, uint8_t *data, size_t data_len)
 Function interface for data stream receiving off a socket. More...
 
ssize_t coap_socket_send (coap_socket_t *sock, const coap_session_t *session, const uint8_t *data, size_t datalen)
 Function interface for data transmission. More...
 
void coap_packet_get_memmapped (coap_packet_t *packet, unsigned char **address, size_t *length)
 Given a packet, set msg and msg_len to an address and length of the packet's data in memory. More...
 
ssize_t coap_socket_recv (coap_socket_t *sock, coap_packet_t *packet)
 Function interface for reading data. More...
 
unsigned int coap_io_prepare_epoll (coap_context_t *ctx, coap_tick_t now)
 Any now timed out delayed packet is transmitted, along with any packets associated with requested observable response. More...
 
unsigned int coap_io_prepare_io (coap_context_t *ctx, coap_socket_t *sockets[], unsigned int max_sockets, unsigned int *num_sockets, coap_tick_t now)
 Iterates through all the coap_socket_t structures embedded in endpoints or sessions associated with the ctx to determine which are wanting any read, write, accept or connect I/O (COAP_SOCKET_WANT_xxx is set). More...
 
int coap_io_process (coap_context_t *ctx, uint32_t timeout_ms)
 The main I/O processing function. More...
 
int coap_io_process_with_fds (coap_context_t *ctx, uint32_t timeout_ms, int enfds, fd_set *ereadfds, fd_set *ewritefds, fd_set *eexceptfds)
 The main message processing loop with additional fds for internal select. More...
 
int coap_io_pending (coap_context_t *context)
 Check to see if there is any i/o pending for the context. More...
 
const char * coap_socket_format_errno (int error)
 
const char * coap_socket_strerror (void)
 

Detailed Description

Network I/O functions.

Definition in file coap_io.c.

Macro Definition Documentation

◆ COAP_SOL_IP

#define COAP_SOL_IP   SOL_IP

Definition at line 757 of file coap_io.c.

◆ iov_len_t

#define iov_len_t   size_t

Definition at line 784 of file coap_io.c.

◆ MSG_NOSIGNAL

#define MSG_NOSIGNAL   0

◆ SIN6

#define SIN6 (   A)    ((struct sockaddr_in6 *)(A))

Definition at line 975 of file coap_io.c.

◆ SOL_IP

#define SOL_IP   IPPROTO_IP

Definition at line 752 of file coap_io.c.

Function Documentation

◆ coap_packet_get_memmapped()

void coap_packet_get_memmapped ( coap_packet_t packet,
unsigned char **  address,
size_t *  length 
)

Given a packet, set msg and msg_len to an address and length of the packet's data in memory.

Definition at line 978 of file coap_io.c.

+ Here is the caller graph for this function:

◆ coap_socket_bind_udp()

int coap_socket_bind_udp ( coap_socket_t sock,
const coap_address_t listen_addr,
coap_address_t bound_addr 
)

Definition at line 92 of file coap_io.c.

+ Here is the call graph for this function:

◆ coap_socket_close()

void coap_socket_close ( coap_socket_t sock)

Function interface to close off a socket.

Parameters
sockSocket to close.

Definition at line 400 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_format_errno()

const char * coap_socket_format_errno ( int  error)

Definition at line 1764 of file coap_io.c.

+ Here is the caller graph for this function:

◆ coap_socket_read()

ssize_t coap_socket_read ( coap_socket_t sock,
uint8_t *  data,
size_t  data_len 
)

Function interface for data stream receiving off a socket.

Parameters
sockSocket to receive data on.
dataThe data to receive.
data_lenThe maximum length of data.
Returns
>=0 Number of bytes read. -1 Error error in errno).

Definition at line 692 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_recv()

ssize_t coap_socket_recv ( coap_socket_t sock,
coap_packet_t packet 
)

Function interface for reading data.

This function returns the number of bytes that have been read, or a value less than zero on error. In case of an error, *packet is set to NULL.

Parameters
sockSocket to read data from.
packetReceived packet metadata and payload. src and dst should be preset.
Returns
The number of bytes received on success, or a value less than zero on error.

Definition at line 991 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_send()

ssize_t coap_socket_send ( coap_socket_t sock,
const coap_session_t session,
const uint8_t *  data,
size_t  datalen 
)

Function interface for data transmission.

This function returns the number of bytes that have been transmitted, or a value less than zero on error.

Parameters
sockSocket to send data over.
sessionAddressing information for unconnected sockets, or NULL
dataThe data to send.
datalenThe actual length of data.
Returns
The number of bytes written on success, or a value less than zero on error.

Definition at line 798 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_strerror()

const char * coap_socket_strerror ( void  )

Definition at line 1768 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_write()

ssize_t coap_socket_write ( coap_socket_t sock,
const uint8_t *  data,
size_t  data_len 
)

Function interface for data stream sending off a socket.

Parameters
sockSocket to send data over.
dataThe data to send.
data_lenThe length of data.
Returns
>=0 Number of bytes sent. -1 Error error in errno).

Definition at line 633 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function: