Collaboration diagram for Simplified UDP API:

Functions
int	simple_udp_send (struct simple_udp_connection c, const void data, uint16_t datalen)
	Send a UDP packet. More...

int	simple_udp_sendto (struct simple_udp_connection c, const void data, uint16_t datalen, const uip_ipaddr_t *to)
	Send a UDP packet to a specified IP address. More...

int	simple_udp_sendto_port (struct simple_udp_connection c, const void data, uint16_t datalen, const uip_ipaddr_t *to, uint16_t port)
	Send a UDP packet to a specified IP address and UDP port. More...

int	simple_udp_register (struct simple_udp_connection c, uint16_t local_port, const uip_ipaddr_t remote_addr, uint16_t remote_port, simple_udp_callback receive_callback)
	Register a UDP connection. More...

void	simple_udp_deregister (struct simple_udp_connection *c)
	Deregister an UDP connection. More...

Detailed Description

The default Contiki UDP API is difficult to use. The simple-udp module provides a significantly simpler API.

Function Documentation

int simple_udp_send	(	struct simple_udp_connection *	c,
		const void *	data,
		uint16_t	datalen
	)

Send a UDP packet.

Parameters

c	A pointer to a struct simple_udp_connection
data	A pointer to the data to be sent
datalen	The length of the data This function sends a UDP packet. The packet will be sent to the IP address and with the UDP ports that were specified when the connection wa registered with simple_udp_register().

See also: simple_udp_sendto()

Definition at line 80 of file simple-udp.c.

References UIP_HTONS.

int simple_udp_sendto	(	struct simple_udp_connection *	c,
		const void *	data,
		uint16_t	datalen,
		const uip_ipaddr_t *	to
	)

Send a UDP packet to a specified IP address.

Parameters

c	A pointer to a struct simple_udp_connection
data	A pointer to the data to be sent
datalen	The length of the data
to	The IP address of the receiver This function sends a UDP packet to a specified IP address. The packet will be sent with the UDP ports that were specified when the connection wa registered with simple_udp_register().

See also: simple_udp_send()

Definition at line 105 of file simple-udp.c.

References UIP_HTONS.

int simple_udp_sendto_port	(	struct simple_udp_connection *	c,
		const void *	data,
		uint16_t	datalen,
		const uip_ipaddr_t *	to,
		uint16_t	port
	)

Send a UDP packet to a specified IP address and UDP port.

Parameters

c	A pointer to a struct simple_udp_connection
data	A pointer to the data to be sent
datalen	The length of the data
to	The IP address of the receiver
port	The UDP port of the receiver, in host byte order This function sends a UDP packet to a specified IP address and UDP port. The packet will be sent with the UDP ports that were specified when the connection wa registered with simple_udp_register().

See also: simple_udp_sendto()

Definition at line 132 of file simple-udp.c.

References UIP_HTONS.

int simple_udp_register	(	struct simple_udp_connection *	c,
		uint16_t	local_port,
		const uip_ipaddr_t *	remote_addr,
		uint16_t	remote_port,
		simple_udp_callback	receive_callback
	)

Register a UDP connection.

Parameters

c	A pointer to a struct simple_udp_connection
local_port	The local UDP port in host byte order
remote_addr	The remote IP address
remote_port	The remote UDP port in host byte order
receive_callback	A pointer to a function to be called for incoming packets

Return values

0 If no UDP connection could be allocated

1

If the connection was successfully allocated

        This function registers a UDP connection and attaches a
        callback function to it. The callback function will be
        called for incoming packets. The local UDP port can be
        set to 0 to indicate that an ephemeral UDP port should
        be allocated. The remote IP address can be NULL, to
        indicate that packets from any IP address should be
        accepted.

Definition at line 164 of file simple-udp.c.

References PROCESS_CONTEXT_BEGIN, PROCESS_CONTEXT_END, udp_bind, udp_new(), UIP_HTONS, and uip_ipaddr_copy.

void simple_udp_deregister ( struct simple_udp_connection * c )

Deregister an UDP connection.

Parameters

c	A pointer to a struct simple_udp_connection This function deallocates an UDP port previously allocated by simple_udp_register() function.

Definition at line 202 of file simple-udp.c.

References uip_udp_conn::appstate, data, uip_udp_conn::lport, PROCESS_BEGIN, PROCESS_CONTEXT_BEGIN, PROCESS_CONTEXT_END, PROCESS_END, PROCESS_THREAD, PROCESS_WAIT_EVENT, tcpip_event, uip_appdata, UIP_BUFSIZE, uip_datalen, UIP_HTONS, uip_newdata, and UIP_UDP_CONNS.

Functions

Detailed Description

Function Documentation