Internal network I/O functions. More...

#include "coap_internal.h"
#include <sys/types.h>
#include "coap_address.h"

Include dependency graph for coap_io_internal.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	coap_socket_t

struct	coap_packet_t

Macros
#define	COAP_SOCKET_EMPTY 0x0000
	coap_socket_flags_t values More...

#define	COAP_SOCKET_NOT_EMPTY 0x0001
	the socket is not empty More...

#define	COAP_SOCKET_BOUND 0x0002
	the socket is bound More...

#define	COAP_SOCKET_CONNECTED 0x0004
	the socket is connected More...

#define	COAP_SOCKET_WANT_READ 0x0010
	non blocking socket is waiting for reading More...

#define	COAP_SOCKET_WANT_WRITE 0x0020
	non blocking socket is waiting for writing More...

#define	COAP_SOCKET_WANT_ACCEPT 0x0040
	non blocking server socket is waiting for accept More...

#define	COAP_SOCKET_WANT_CONNECT 0x0080
	non blocking client socket is waiting for connect More...

#define	COAP_SOCKET_CAN_READ 0x0100
	non blocking socket can now read without blocking More...

#define	COAP_SOCKET_CAN_WRITE 0x0200
	non blocking socket can now write without blocking More...

#define	COAP_SOCKET_CAN_ACCEPT 0x0400
	non blocking server socket can now accept without blocking More...

#define	COAP_SOCKET_CAN_CONNECT 0x0800
	non blocking client socket can now connect without blocking More...

#define	COAP_SOCKET_MULTICAST 0x1000
	socket is used for multicast communication More...

Functions
coap_endpoint_t *	coap_malloc_endpoint (void)

void	coap_mfree_endpoint (coap_endpoint_t *ep)

const char *	coap_socket_format_errno (int error)

int	coap_socket_connect_udp (coap_socket_t sock, const coap_address_t local_if, const coap_address_t server, int default_port, coap_address_t local_addr, coap_address_t *remote_addr)

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)

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

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

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

void	coap_epoll_ctl_mod (coap_socket_t sock, uint32_t events, const char func)

void	coap_update_epoll_timer (coap_context_t *context, coap_tick_t delay)
	Update the epoll timer fd as to when it is to trigger. More...

ssize_t	coap_network_send (coap_socket_t sock, const coap_session_t session, const uint8_t *data, size_t datalen)
	Function interface for data transmission. More...

ssize_t	coap_network_read (coap_socket_t sock, coap_packet_t packet)
	Function interface for reading data. 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...

Detailed Description

Internal network I/O functions.

Definition in file coap_io_internal.h.

Macro Definition Documentation

◆ COAP_SOCKET_BOUND

#define COAP_SOCKET_BOUND 0x0002

the socket is bound

Definition at line 51 of file coap_io_internal.h.

◆ COAP_SOCKET_CAN_ACCEPT

#define COAP_SOCKET_CAN_ACCEPT 0x0400

non blocking server socket can now accept without blocking

Definition at line 59 of file coap_io_internal.h.

◆ COAP_SOCKET_CAN_CONNECT

#define COAP_SOCKET_CAN_CONNECT 0x0800

non blocking client socket can now connect without blocking

Definition at line 60 of file coap_io_internal.h.

◆ COAP_SOCKET_CAN_READ

#define COAP_SOCKET_CAN_READ 0x0100

non blocking socket can now read without blocking

Definition at line 57 of file coap_io_internal.h.

◆ COAP_SOCKET_CAN_WRITE

#define COAP_SOCKET_CAN_WRITE 0x0200

non blocking socket can now write without blocking

Definition at line 58 of file coap_io_internal.h.

◆ COAP_SOCKET_CONNECTED

#define COAP_SOCKET_CONNECTED 0x0004

the socket is connected

Definition at line 52 of file coap_io_internal.h.

◆ COAP_SOCKET_EMPTY

#define COAP_SOCKET_EMPTY 0x0000

coap_socket_flags_t values

the socket is not used

Definition at line 49 of file coap_io_internal.h.

◆ COAP_SOCKET_MULTICAST

#define COAP_SOCKET_MULTICAST 0x1000

socket is used for multicast communication

Definition at line 61 of file coap_io_internal.h.

◆ COAP_SOCKET_NOT_EMPTY

#define COAP_SOCKET_NOT_EMPTY 0x0001

the socket is not empty

Definition at line 50 of file coap_io_internal.h.

◆ COAP_SOCKET_WANT_ACCEPT

#define COAP_SOCKET_WANT_ACCEPT 0x0040

non blocking server socket is waiting for accept

Definition at line 55 of file coap_io_internal.h.

◆ COAP_SOCKET_WANT_CONNECT

#define COAP_SOCKET_WANT_CONNECT 0x0080

non blocking client socket is waiting for connect

Definition at line 56 of file coap_io_internal.h.

◆ COAP_SOCKET_WANT_READ

#define COAP_SOCKET_WANT_READ 0x0010

non blocking socket is waiting for reading

Definition at line 53 of file coap_io_internal.h.

◆ COAP_SOCKET_WANT_WRITE

#define COAP_SOCKET_WANT_WRITE 0x0020

non blocking socket is waiting for writing

Definition at line 54 of file coap_io_internal.h.

Function Documentation

◆ coap_epoll_ctl_mod()

void coap_epoll_ctl_mod	(	coap_socket_t *	sock,
		uint32_t	events,
		const char *	func
	)

Here is the caller graph for this function:

◆ coap_malloc_endpoint()

coap_endpoint_t * coap_malloc_endpoint ( void )

Definition at line 175 of file coap_io_contiki.c.

Here is the call graph for this function:

◆ coap_mfree_endpoint()

void coap_mfree_endpoint ( coap_endpoint_t * ep )

Definition at line 180 of file coap_io_contiki.c.

Here is the call graph for this function:

◆ coap_network_read()

ssize_t coap_network_read	(	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

sock	Socket to read data from
packet	Received 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 811 of file coap_io.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_network_send()

ssize_t coap_network_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

sock	Socket to send data with
session	Addressing information for unconnected sockets, or NULL
data	The data to send.
datalen	The actual length of `data`.

Returns: The number of bytes written on success, or a value less than zero on error.

Definition at line 630 of file coap_io.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 804 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 161 of file coap_io.c.

Here is the call graph for this function:

◆ coap_socket_close()

void coap_socket_close ( coap_socket_t * sock )

Definition at line 377 of file coap_io.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_socket_connect_udp()

int coap_socket_connect_udp	(	coap_socket_t *	sock,
		const coap_address_t *	local_if,
		const coap_address_t *	server,
		int	default_port,
		coap_address_t *	local_addr,
		coap_address_t *	remote_addr
	)

Definition at line 542 of file coap_io_contiki.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 1601 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
	)

Definition at line 537 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,
		coap_session_t *	session,
		const uint8_t *	data,
		size_t	data_len
	)

Definition at line 1610 of file coap_io.c.

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
	)

Definition at line 483 of file coap_io.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_update_epoll_timer()

void coap_update_epoll_timer	(	coap_context_t *	context,
		coap_tick_t	delay
	)

Update the epoll timer fd as to when it is to trigger.

Parameters

context	The context to update the epoll timer on.
delay	The time to delay before the epoll timer fires.

Here is the caller graph for this function:

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ COAP_SOCKET_BOUND

◆ COAP_SOCKET_CAN_ACCEPT

◆ COAP_SOCKET_CAN_CONNECT

◆ COAP_SOCKET_CAN_READ

◆ COAP_SOCKET_CAN_WRITE

◆ COAP_SOCKET_CONNECTED

◆ COAP_SOCKET_EMPTY

◆ COAP_SOCKET_MULTICAST

◆ COAP_SOCKET_NOT_EMPTY

◆ COAP_SOCKET_WANT_ACCEPT

◆ COAP_SOCKET_WANT_CONNECT

◆ COAP_SOCKET_WANT_READ

◆ COAP_SOCKET_WANT_WRITE

Function Documentation

◆ coap_epoll_ctl_mod()

◆ coap_malloc_endpoint()

◆ coap_mfree_endpoint()

◆ coap_network_read()

◆ coap_network_send()

◆ coap_packet_get_memmapped()

◆ coap_socket_bind_udp()

◆ coap_socket_close()

◆ coap_socket_connect_udp()

◆ coap_socket_format_errno()

◆ coap_socket_read()

◆ coap_socket_send()

◆ coap_socket_write()

◆ coap_update_epoll_timer()