#include "config.h"
#include <ctype.h>
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include "debug.h"
#include "mem.h"
#include "str.h"
#include "async.h"
#include "resource.h"
#include "option.h"
#include "encode.h"
#include "net.h"

Macros
#define	is_wkc(Key) (memcmp((Key), COAP_DEFAULT_WKC_HASHKEY, sizeof(coap_key_t)) == 0)
	Checks if `Key` is equal to the pre-defined hash key for.well-known/core.
#define	INET6_ADDRSTRLEN 40
#define	WANT_WKC(Pdu, Key) (((Pdu)->hdr->code == COAP_REQUEST_GET) && is_wkc(Key))

Functions
static coap_queue_t *	coap_malloc_node ()
static void	coap_free_node (coap_queue_t *node)
int	print_wellknown (coap_context_t , unsigned char , size_t , coap_opt_t )
	Prints the names of all known resources to `buf`.
void	coap_handle_failed_notify (coap_context_t , const coap_address_t , const str *)
int	coap_insert_node (coap_queue_t *queue, coap_queue_t node, int(order)(coap_queue_t , coap_queue_t *node))
int	coap_delete_node (coap_queue_t *node)
void	coap_delete_all (coap_queue_t *queue)
coap_queue_t *	coap_new_node ()
coap_queue_t *	coap_peek_next (coap_context_t *context)
coap_queue_t *	coap_pop_next (coap_context_t *context)
coap_context_t *	coap_new_context (const coap_address_t *listen_addr)
void	coap_free_context (coap_context_t *context)
int	coap_option_check_critical (coap_context_t ctx, coap_pdu_t pdu, coap_opt_filter_t unknown)
	Verifies that `pdu` contains no unknown critical options.
void	coap_transaction_id (const coap_address_t peer, const coap_pdu_t pdu, coap_tid_t *id)
	Calculates a unique transaction id from given arguments `peer` and `pdu`.
coap_tid_t	coap_send_ack (coap_context_t context, const coap_address_t dst, coap_pdu_t *request)
	Sends an ACK message with code `0` for the specified `request` to `dst`.
coap_tid_t	coap_send_impl (coap_context_t context, const coap_address_t dst, coap_pdu_t *pdu)
coap_tid_t	coap_send (coap_context_t context, const coap_address_t dst, coap_pdu_t *pdu)
	Sends a non-confirmed CoAP message to given destination.
coap_tid_t	coap_send_error (coap_context_t context, coap_pdu_t request, const coap_address_t *dst, unsigned char code, coap_opt_filter_t opts)
	Sends an error response with code `code` for request `request` to `dst`.
coap_tid_t	coap_send_message_type (coap_context_t context, const coap_address_t dst, coap_pdu_t *request, unsigned char type)
	Helper funktion to create and send a message with `type` (usually ACK or RST).
int	_order_timestamp (coap_queue_t lhs, coap_queue_t rhs)
coap_tid_t	coap_send_confirmed (coap_context_t context, const coap_address_t dst, coap_pdu_t *pdu)
	Sends a confirmed CoAP message to given destination.
coap_tid_t	coap_retransmit (coap_context_t context, coap_queue_t node)
	Handles retransmissions of confirmable messages.
int	_order_transaction_id (coap_queue_t lhs, coap_queue_t rhs)
static int	check_opt_size (coap_opt_t opt, unsigned char maxpos)
	Checks if `opt` fits into the message that ends with `maxpos`.
int	coap_read (coap_context_t *ctx)
	Reads data from the network and tries to parse as CoAP PDU.
int	coap_remove_from_queue (coap_queue_t queue, coap_tid_t id, coap_queue_t node)
	This function removes the element with given `id` from the list given list.
static int	token_match (const unsigned char a, size_t alen, const unsigned char b, size_t blen)
void	coap_cancel_all_messages (coap_context_t context, const coap_address_t dst, const unsigned char *token, size_t token_length)
	Cancels all outstanding messages for peer `dst` that have the specified token.
coap_queue_t *	coap_find_transaction (coap_queue_t *queue, coap_tid_t id)
	Retrieves transaction from queue.
coap_pdu_t *	coap_new_error_response (coap_pdu_t *request, unsigned char code, coap_opt_filter_t opts)
	Creates a new ACK PDU with specified error `code`.
coap_pdu_t *	wellknown_response (coap_context_t context, coap_pdu_t request)
void	handle_request (coap_context_t context, coap_queue_t node)
static void	handle_response (coap_context_t context, coap_queue_t sent, coap_queue_t *rcvd)
static int	handle_locally (coap_context_t context, coap_queue_t node)
static void	coap_handle_rst (coap_context_t context, const coap_queue_t sent)
	This function handles RST messages received for the message passed in `sent`.
void	coap_dispatch (coap_context_t *context)
	Dispatches the PDUs from the receive queue in given context.
int	coap_can_exit (coap_context_t *context)
	Returns 1 if there are no messages to send or to dispatch in the context's queues.

Variables
time_t	clock_offset
	Set at startup to initialize the internal clock (time in seconds).

Macro Definition Documentation

#define INET6_ADDRSTRLEN 40

#define is_wkc ( Key ) (memcmp((Key), COAP_DEFAULT_WKC_HASHKEY, sizeof(coap_key_t)) == 0)

Checks if Key is equal to the pre-defined hash key for.well-known/core.

Definition at line 182 of file net.c.

#define WANT_WKC	(	Pdu,
		Key
	)	(((Pdu)->hdr->code == COAP_REQUEST_GET) && is_wkc(Key))

Definition at line 973 of file net.c.

Function Documentation

int _order_timestamp	(	coap_queue_t *	lhs,
		coap_queue_t *	rhs
	)

Definition at line 500 of file net.c.

int _order_transaction_id	(	coap_queue_t *	lhs,
		coap_queue_t *	rhs
	)

Definition at line 607 of file net.c.

static int check_opt_size	(	coap_opt_t *	opt,
		unsigned char *	maxpos
	)

inlinestatic

Checks if opt fits into the message that ends with maxpos.

This function returns 1 on success, or 0 if the option opt would exceed maxpos.

Definition at line 620 of file net.c.

int coap_can_exit ( coap_context_t * context )

Returns 1 if there are no messages to send or to dispatch in the context's queues.

Definition at line 1244 of file net.c.

void coap_cancel_all_messages	(	coap_context_t *	context,
		const coap_address_t *	dst,
		const unsigned char *	token,
		size_t	token_length
	)

Cancels all outstanding messages for peer dst that have the specified token.

Parameters

context	The context in use
dst	Destination address of the messages to remove.
token	Message token
token_length	Actual length of `token`

Definition at line 768 of file net.c.

void coap_delete_all ( coap_queue_t * queue )

Definition at line 135 of file net.c.

int coap_delete_node ( coap_queue_t * node )

Definition at line 124 of file net.c.

void coap_dispatch ( coap_context_t * context )

Dispatches the PDUs from the receive queue in given context.

Definition at line 1139 of file net.c.

coap_queue_t* coap_find_transaction	(	coap_queue_t *	queue,
		coap_tid_t	id
	)

Retrieves transaction from queue.

The transaction queue to be searched Unique key of the transaction to find.

Returns: A pointer to the transaction object or NULL if not found

Definition at line 809 of file net.c.

void coap_free_context ( coap_context_t * context )

Definition at line 298 of file net.c.

static void coap_free_node ( coap_queue_t * node )

inlinestatic

Definition at line 48 of file net.c.

void coap_handle_failed_notify	(	coap_context_t *	,
		const coap_address_t *	,
		const str *
	)

Definition at line 693 of file resource.c.

static void coap_handle_rst	(	coap_context_t *	context,
		const coap_queue_t *	sent
	)

static

This function handles RST messages received for the message passed in sent.

Definition at line 1110 of file net.c.

int coap_insert_node	(	coap_queue_t **	queue,
		coap_queue_t *	node,
		int()(coap_queue_t , coap_queue_t *node)	order
	)

Definition at line 91 of file net.c.

static coap_queue_t* coap_malloc_node ( )

inlinestatic

Definition at line 43 of file net.c.

coap_context_t* coap_new_context ( const coap_address_t * listen_addr )

Definition at line 200 of file net.c.

coap_pdu_t* coap_new_error_response	(	coap_pdu_t *	request,
		unsigned char	code,
		coap_opt_filter_t	opts
	)

Creates a new ACK PDU with specified error code.

The options specified by the filter expression opts will be copied from the original request contained in request. Unless SHORT_ERROR_RESPONSE was defined at build time, the textual reason phrase for code will be added as payload, with Content-Type 0. This function returns a pointer to the new response message, or NULL on error. The storage allocated for the new message must be relased with coap_free().

Parameters

request	Specification of the received (confirmable) request.
code	The error code to set.
opts	An option filter that specifies which options to copy from the original request in `node`.

Returns: A pointer to the new message or NULL on error.

Definition at line 817 of file net.c.

coap_queue_t* coap_new_node ( )

Definition at line 144 of file net.c.

int coap_option_check_critical	(	coap_context_t *	ctx,
		coap_pdu_t *	pdu,
		coap_opt_filter_t	unknown
	)

Verifies that pdu contains no unknown critical options.

Options must be registered at ctx, using the function coap_register_option(). A basic set of options is registered automatically by coap_new_context(). This function returns 1 if pdu is ok, 0 otherwise. The given filter object unknown will be updated with the unknown options. As only COAP_MAX_OPT options can be signalled this way, remaining options must be examined manually.

coap_opt_filter_t f = COAP_OPT_NONE;
coap_opt_iterator_t opt_iter;
if (coap_option_check_critical(ctx, pdu, f) == 0) {
  coap_option_iterator_init(pdu, &opt_iter, f);
  while (coap_option_next(&opt_iter)) {
    if (opt_iter.type & 0x01) {
  ... handle unknown critical option in opt_iter ...
    }
  }
}

Parameters

ctx	The context where all known options are registered.
pdu	The PDU to check.
unknown	The output filter that will be updated to indicate the unknown critical options found in `pdu`.

Returns: 1 if everything was ok, 0 otherwise.

Definition at line 323 of file net.c.

coap_queue_t* coap_peek_next ( coap_context_t * context )

Definition at line 160 of file net.c.

coap_queue_t* coap_pop_next ( coap_context_t * context )

Definition at line 168 of file net.c.

int coap_read ( coap_context_t * context )

Reads data from the network and tries to parse as CoAP PDU.

On success, 0 is returned and a new node with the parsed PDU is added to the receive queue in the specified context object.

Definition at line 629 of file net.c.

int coap_remove_from_queue	(	coap_queue_t **	queue,
		coap_tid_t	id,
		coap_queue_t **	node
	)

This function removes the element with given id from the list given list.

If id was found, node is updated to point to the removed element. Note that the storage allocated by node is not released. The caller must do this manually using coap_delete_node(). This function returns 1 if the element with id id was found, 0 otherwise. For a return value of 0, the contents of node is undefined.

Parameters

queue	The queue to search for `id`.
id	The node id to look for.
node	If found, `node` is updated to point to the removed node. You must release the storage pointed to by `node` manually.

Returns: 1 if id was found, 0 otherwise.

Definition at line 724 of file net.c.

coap_tid_t coap_retransmit	(	coap_context_t *	context,
		coap_queue_t *	node
	)

Handles retransmissions of confirmable messages.

Definition at line 560 of file net.c.

coap_tid_t coap_send	(	coap_context_t *	context,
		const coap_address_t *	dst,
		coap_pdu_t *	pdu
	)

Sends a non-confirmed CoAP message to given destination.

The memory that is allocated by pdu will not be released by coap_send(). The caller must release the memory.

Parameters

context	The CoAP context to use.
dst	The address to send to.
pdu	The CoAP PDU to send.

Returns: The message id of the sent message or COAP_INVALID_TID on error.

Definition at line 454 of file net.c.

coap_tid_t coap_send_ack	(	coap_context_t *	context,
		const coap_address_t *	dst,
		coap_pdu_t *	request
	)

Sends an ACK message with code 0 for the specified request to dst.

This function returns the corresponding transaction id if the message was sent or COAP_INVALID_TID on error.

Parameters

context	The context to use.
dst	The destination address.
request	The request to be acknowledged.

Returns: The transaction id if ACK was sent or COAP_INVALID_TID on error.

Definition at line 392 of file net.c.

coap_tid_t coap_send_confirmed	(	coap_context_t *	context,
		const coap_address_t *	dst,
		coap_pdu_t *	pdu
	)

Sends a confirmed CoAP message to given destination.

The memory that is allocated by pdu will not be released by coap_send_confirmed(). The caller must release the memory.

Parameters

context	The CoAP context to use.
dst	The address to send to.
pdu	The CoAP PDU to send.

Returns: The message id of the sent message or COAP_INVALID_TID on error.

Definition at line 505 of file net.c.

coap_tid_t coap_send_error	(	coap_context_t *	context,
		coap_pdu_t *	request,
		const coap_address_t *	dst,
		unsigned char	code,
		coap_opt_filter_t	opts
	)

Sends an error response with code code for request request to dst.

opts will be passed to coap_new_error_response() to copy marked options from the request. This function returns the transaction id if the message was sent, or COAP_INVALID_TID otherwise.

Parameters

context	The context to use.
request	The original request to respond to.
dst	The remote peer that sent the request.
code	The reponse code.
opts	A filter that specifies the options to copy from the `request`.

Returns: The transaction id if the message was sent, or COAP_INVALID_TID otherwise.

Definition at line 461 of file net.c.

coap_tid_t coap_send_impl	(	coap_context_t *	context,
		const coap_address_t *	dst,
		coap_pdu_t *	pdu
	)

Definition at line 412 of file net.c.

coap_tid_t coap_send_message_type	(	coap_context_t *	context,
		const coap_address_t *	dst,
		coap_pdu_t *	request,
		unsigned char	type
	)

Helper funktion to create and send a message with type (usually ACK or RST).

This function returns COAP_INVALID_TID when the message was not sent, a valid transaction id otherwise.

Parameters

context	The CoAP context.
dst	Where to send the context.
request	The request that should be responded to.
type	Which type to set

Returns: transaction id on success or COAP_INVALID_TID otherwise.

Definition at line 482 of file net.c.

void coap_transaction_id	(	const coap_address_t *	peer,
		const coap_pdu_t *	pdu,
		coap_tid_t *	id
	)

Calculates a unique transaction id from given arguments peer and pdu.

The id is returned in id.

Parameters

peer	The remote party who sent `pdu`.
pdu	The message that initiated the transaction.
id	Set to the new id.

Definition at line 358 of file net.c.

static int handle_locally	(	coap_context_t *	context,
		coap_queue_t *	node
	)

inlinestatic

Definition at line 1099 of file net.c.

void handle_request	(	coap_context_t *	context,
		coap_queue_t *	node
	)

Definition at line 977 of file net.c.

static void handle_response	(	coap_context_t *	context,
		coap_queue_t *	sent,
		coap_queue_t *	rcvd
	)

inlinestatic

Definition at line 1079 of file net.c.

int print_wellknown	(	coap_context_t *	context,
		unsigned char *	buf,
		size_t *	buflen,
		coap_opt_t *	query_filter
	)

Prints the names of all known resources to buf.

This function sets buflen to the number of bytes actually written and returns 1 on succes. On error, the value in buflen is undefined and the return value will be 0.

Parameters

context	The context with the resource map.
buf	The buffer to write the result.
buflen	Must be initialized to the maximum length of `buf` and will be set to the number of bytes written on return.
query_filter	A filter query according to Link Format

Returns: 0 on error or 1 on success.

Definition at line 105 of file resource.c.

static int token_match	(	const unsigned char *	a,
		size_t	alen,
		const unsigned char *	b,
		size_t	blen
	)

inlinestatic

Definition at line 762 of file net.c.

coap_pdu_t* wellknown_response	(	coap_context_t *	context,
		coap_pdu_t *	request
	)

Definition at line 910 of file net.c.

Macros

Functions

Variables

Macro Definition Documentation

Function Documentation