libcoap 4.3.3

Internal API for Netif Support. More...

+ Collaboration diagram for Netif Support:

Functions

int coap_netif_available (coap_session_t *session)
 Function interface to check whether netif for session is still available. More...
 
int coap_netif_available_ep (coap_endpoint_t *endpoint)
 Function interface to check whether netif for endpoint is still available. More...
 
int coap_netif_dgrm_listen (coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
 Layer function interface for Netif datagram listem (udp). More...
 
int coap_netif_dgrm_connect (coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
 Layer function interface for Netif datagram connect (udp). More...
 
ssize_t coap_netif_dgrm_read (coap_session_t *session, coap_packet_t *packet)
 Function interface for layer data datagram receiving for sessions. More...
 
ssize_t coap_netif_dgrm_read_ep (coap_endpoint_t *endpoint, coap_packet_t *packet)
 Function interface for layer data datagram receiving for endpoints. More...
 
ssize_t coap_netif_dgrm_write (coap_session_t *session, const uint8_t *data, size_t datalen)
 Function interface for netif datagram data transmission. More...
 
int coap_netif_strm_listen (coap_endpoint_t *endpoint, const coap_address_t *listen_addr)
 Layer function interface for Netif stream listem (tcp). More...
 
int coap_netif_strm_accept (coap_endpoint_t *endpoint, coap_session_t *session)
 Layer function interface for Netif stream accept. More...
 
int coap_netif_strm_connect1 (coap_session_t *session, const coap_address_t *local_if, const coap_address_t *server, int default_port)
 Layer function interface for Netif stream connect (tcp). More...
 
int coap_netif_strm_connect2 (coap_session_t *session)
 Layer function interface for Netif stream connect (tcp). More...
 
ssize_t coap_netif_strm_read (coap_session_t *session, uint8_t *data, size_t datalen)
 Function interface for layer data stream receiving. More...
 
ssize_t coap_netif_strm_write (coap_session_t *session, const uint8_t *data, size_t datalen)
 Function interface for netif stream data transmission. More...
 
void coap_netif_close (coap_session_t *session)
 Layer function interface for Netif close for a session. More...
 
void coap_netif_close_ep (coap_endpoint_t *endpoint)
 Layer function interface for Netif close for a endpoint. More...
 

Detailed Description

Internal API for Netif Support.

This provides a layer that sits between CoAP/DTLS and Sockets.

Function Documentation

◆ coap_netif_available()

int coap_netif_available ( coap_session_t session)

Function interface to check whether netif for session is still available.

Parameters
sessionSession to check against.
Returns
1 If netif is available, else 0.

Definition at line 25 of file coap_netif.c.

+ Here is the caller graph for this function:

◆ coap_netif_available_ep()

int coap_netif_available_ep ( coap_endpoint_t endpoint)

Function interface to check whether netif for endpoint is still available.

Parameters
endpointEndpoint to check against.
Returns
1 If netif is available, else 0.

◆ coap_netif_close()

void coap_netif_close ( coap_session_t session)

Layer function interface for Netif close for a session.

Parameters
sessionSession to do the netif close on.

Definition at line 258 of file coap_netif.c.

+ Here is the call graph for this function:

◆ coap_netif_close_ep()

void coap_netif_close_ep ( coap_endpoint_t endpoint)

Layer function interface for Netif close for a endpoint.

Parameters
endpointEndpoint to do the netif close on.

◆ coap_netif_dgrm_connect()

int coap_netif_dgrm_connect ( coap_session_t session,
const coap_address_t local_if,
const coap_address_t server,
int  default_port 
)

Layer function interface for Netif datagram connect (udp).

Parameters
sessionSession to do the connect on.
local_ifThe local interface to bind to or NULL.
serverThe server to connect to.
default_portThe Port to connect to if not defined.
Returns
1 OK, 0 on failure.

◆ coap_netif_dgrm_listen()

int coap_netif_dgrm_listen ( coap_endpoint_t endpoint,
const coap_address_t listen_addr 
)

Layer function interface for Netif datagram listem (udp).

Parameters
endpointEndpoint to do the listen on.
listen_addrThe local address to bind.
Returns
1 OK, 0 on failure.

◆ coap_netif_dgrm_read()

ssize_t coap_netif_dgrm_read ( coap_session_t session,
coap_packet_t packet 
)

Function interface for layer data datagram receiving for sessions.

This function returns the number of bytes that have been read, or -1 on error.

Parameters
sessionSession to receive data on.
packetWhere to put the received information
Returns
>=0 Number of bytes read. -1 Error of some sort (see errno). -2 ICMP error response

Definition at line 72 of file coap_netif.c.

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

◆ coap_netif_dgrm_read_ep()

ssize_t coap_netif_dgrm_read_ep ( coap_endpoint_t endpoint,
coap_packet_t packet 
)

Function interface for layer data datagram receiving for endpoints.

This function returns the number of bytes that have been read, or -1 on error.

Parameters
endpointEndpoint to receive data on.
packetWhere to put the received information
Returns
>=0 Number of bytes read. -1 Error of some sort (see errno). -2 ICMP error response

◆ coap_netif_dgrm_write()

ssize_t coap_netif_dgrm_write ( coap_session_t session,
const uint8_t *  data,
size_t  datalen 
)

Function interface for netif datagram data transmission.

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

Parameters
sessionSession to send data on.
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 123 of file coap_netif.c.

+ Here is the call graph for this function:

◆ coap_netif_strm_accept()

int coap_netif_strm_accept ( coap_endpoint_t endpoint,
coap_session_t session 
)

Layer function interface for Netif stream accept.

Parameters
endpointEndpoint to to do the accept on.
sessionSession to to do the accept update on.
Returns
1 OK, 0 on failure.

◆ coap_netif_strm_connect1()

int coap_netif_strm_connect1 ( coap_session_t session,
const coap_address_t local_if,
const coap_address_t server,
int  default_port 
)

Layer function interface for Netif stream connect (tcp).

Step 1 - initiate the connection.

Parameters
sessionSession to do the connect on.
local_ifThe local interface to bind to or NULL.
serverThe server to connect to.
default_portThe Port to connect to if not defined.
Returns
1 OK, 0 on failure.

◆ coap_netif_strm_connect2()

int coap_netif_strm_connect2 ( coap_session_t session)

Layer function interface for Netif stream connect (tcp).

Step 2 - complete the connection.

Parameters
sessionSession to do the connect complete on.
Returns
1 OK, 0 on failure.

◆ coap_netif_strm_listen()

int coap_netif_strm_listen ( coap_endpoint_t endpoint,
const coap_address_t listen_addr 
)

Layer function interface for Netif stream listem (tcp).

Parameters
endpointEndpoint to do the listen on.
listen_addrThe local address to bind.
Returns
1 OK, 0 on failure.

◆ coap_netif_strm_read()

ssize_t coap_netif_strm_read ( coap_session_t session,
uint8_t *  data,
size_t  datalen 
)

Function interface for layer data stream receiving.

This function returns the number of bytes that have been read, or -1 on error.

Parameters
sessionSession to receive data on.
dataThe data to receive.
datalenThe maximum length of data.
Returns
>=0 Number of bytes read. -1 Error of some sort (see errno).

Definition at line 213 of file coap_netif.c.

+ Here is the call graph for this function:

◆ coap_netif_strm_write()

ssize_t coap_netif_strm_write ( coap_session_t session,
const uint8_t *  data,
size_t  datalen 
)

Function interface for netif stream data transmission.

This function returns the number of bytes that have been transmitted, or a value less than zero on error. The number of bytes written may be less than datalen because of congestion control.

Parameters
sessionSession to send data on.
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 234 of file coap_netif.c.

+ Here is the call graph for this function: