libcoap  4.3.1
net.h
Go to the documentation of this file.
1 /*
2  * net.h -- CoAP context interface
3  *
4  * Copyright (C) 2010-2022 Olaf Bergmann <bergmann@tzi.org>
5  *
6  * SPDX-License-Identifier: BSD-2-Clause
7  *
8  * This file is part of the CoAP library libcoap. Please see README for terms
9  * of use.
10  */
11 
17 #ifndef COAP_NET_H_
18 #define COAP_NET_H_
19 
20 #include <stdlib.h>
21 #include <string.h>
22 #ifndef _WIN32
23 #include <sys/select.h>
24 #include <sys/time.h>
25 #endif
26 #include <time.h>
27 
28 #ifdef WITH_LWIP
29 #include <lwip/ip_addr.h>
30 #endif
31 
32 #include "coap_io.h"
33 #include "coap_dtls.h"
34 #include "coap_event.h"
35 #include "pdu.h"
36 #include "coap_session.h"
37 
45 typedef enum coap_response_t {
49 
62  const coap_pdu_t *sent,
63  const coap_pdu_t *received,
64  const coap_mid_t mid);
65 
74 typedef void (*coap_nack_handler_t)(coap_session_t *session,
75  const coap_pdu_t *sent,
76  const coap_nack_reason_t reason,
77  const coap_mid_t mid);
78 
86 typedef void (*coap_ping_handler_t)(coap_session_t *session,
87  const coap_pdu_t *received,
88  const coap_mid_t mid);
89 
97 typedef void (*coap_pong_handler_t)(coap_session_t *session,
98  const coap_pdu_t *received,
99  const coap_mid_t mid);
100 
108 void
110  coap_response_handler_t handler);
111 
121 void
123  coap_nack_handler_t handler);
124 
132 void
134  coap_ping_handler_t handler);
135 
143 void
145  coap_pong_handler_t handler);
146 
153 void
154 coap_register_option(coap_context_t *ctx, uint16_t type);
155 
159 coap_context_t *coap_new_context(const coap_address_t *listen_addr);
160 
173 int coap_context_set_psk( coap_context_t *context, const char *hint,
174  const uint8_t *key, size_t key_len );
175 
186  coap_dtls_spsk_t *setup_data);
187 
197 int
199  const coap_dtls_pki_t *setup_data);
200 
212 int
214  const char *ca_file,
215  const char *ca_dir);
216 
233 void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
234 
243 int coap_context_get_coap_fd(const coap_context_t *context);
244 
254 void
256  unsigned int max_idle_sessions);
257 
265 unsigned int
267 
276 void
278  unsigned int session_timeout);
279 
287 unsigned int
289 
298 void
300  unsigned int csm_tmeout);
301 
309 unsigned int
311 
318 void
320  uint32_t csm_max_message_size);
321 
329 uint32_t
331 
341 void
343  unsigned int max_handshake_sessions);
344 
352 unsigned int
354 
364 uint16_t coap_new_message_id(coap_session_t *session);
365 
374 void coap_free_context(coap_context_t *context);
375 
385 void coap_set_app_data(coap_context_t *context, void *data);
386 
396 void *coap_get_app_data(const coap_context_t *context);
397 
416  coap_pdu_code_t code,
417  coap_opt_filter_t *opts);
418 
435  const coap_pdu_t *request,
436  coap_pdu_code_t code,
437  coap_opt_filter_t *opts);
438 
451 coap_send_message_type(coap_session_t *session, const coap_pdu_t *request,
452  coap_pdu_type_t type);
453 
465 coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request);
466 
479 coap_send_rst(coap_session_t *session, const coap_pdu_t *request) {
480  return coap_send_message_type(session, request, COAP_MESSAGE_RST);
481 }
482 
495 
496 #define coap_send_large(session, pdu) coap_send(session, pdu)
497 
508 int coap_handle_event(coap_context_t *context,
509  coap_event_t event,
510  coap_session_t *session);
521 int coap_can_exit(coap_context_t *context);
522 
528 
540 int
541 coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
542  const char *ifname);
543 
544 #define coap_join_mcast_group(ctx, groupname) \
545  (coap_join_mcast_group_intf(ctx, groupname, NULL))
546 
557 int
558 coap_mcast_set_hops(coap_session_t *session, size_t hops);
559 
567 void
569 
579 #define COAP_IO_WAIT 0
580 #define COAP_IO_NO_WAIT ((uint32_t)-1)
581 
610 int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
611 
612 #ifndef RIOT_VERSION
640 int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms,
641  int nfds, fd_set *readfds, fd_set *writefds,
642  fd_set *exceptfds);
643 #endif /* !RIOT_VERSION */
644 
687 unsigned int
689  coap_socket_t *sockets[],
690  unsigned int max_sockets,
691  unsigned int *num_sockets,
692  coap_tick_t now
693 );
694 
709 
729 unsigned int
731 
732 struct epoll_event;
733 
747 void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event* events,
748  size_t nevents);
749 
772 coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
773 {
774  return coap_io_process(ctx, timeout_ms);
775 }
776 
797  coap_socket_t *sockets[],
798  unsigned int max_sockets,
799  unsigned int *num_sockets,
800  coap_tick_t now
801 ) {
802  return coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now);
803 }
804 
817 ) {
818  coap_io_do_io(ctx, now);
819 }
820 
821 /* Old definitions which may be hanging around in old code - be helpful! */
822 #define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
823 #define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
824 
825 #endif /* COAP_NET_H_ */
CoAP DTLS support.
Event handling.
Default network I/O functions.
coap_nack_reason_t
Definition: coap_io.h:69
Defines the application visible session information.
void coap_io_do_io(coap_context_t *ctx, coap_tick_t now)
Processes any outstanding read, write, accept or connect I/O as indicated in the coap_socket_t struct...
Definition: net.c:1879
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 obs...
Definition: coap_io.c:1073
void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition: net.c:1935
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 t...
Definition: coap_io.c:1125
int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition: coap_io.c:1360
int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms, int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds)
The main message processing loop with additional fds for internal select.
Definition: coap_io.c:1365
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:127
coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request)
Sends an ACK message with code 0 for the specified request to dst.
Definition: net.c:756
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition: net.c:463
int coap_context_set_psk2(coap_context_t *context, coap_dtls_spsk_t *setup_data)
Set the context's default PSK hint and/or key for a server.
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:435
uint16_t coap_new_message_id(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
void(* coap_pong_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Pong handler that is used as callback in coap_context_t.
Definition: net.h:97
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition: net.c:424
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: net.c:3363
void coap_mcast_per_resource(coap_context_t *context)
Function interface to enable processing mcast requests on a per resource basis.
coap_response_t(* coap_response_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_pdu_t *received, const coap_mid_t mid)
Response handler that is used as callback in coap_context_t.
Definition: net.h:61
void coap_context_set_csm_max_message_size(coap_context_t *context, uint32_t csm_max_message_size)
Set the CSM max session size value.
Definition: net.c:451
void coap_register_response_handler(coap_context_t *context, coap_response_handler_t handler)
Registers a new message handler that is called whenever a response is received.
Definition: net.c:3453
void * coap_get_app_data(const coap_context_t *context)
Returns any application-specific data that has been stored with context using the function coap_set_a...
Definition: net.c:605
void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition: net.c:611
void coap_context_set_max_handshake_sessions(coap_context_t *context, unsigned int max_handshake_sessions)
Set the maximum number of sessions in (D)TLS handshake value.
Definition: net.c:429
int coap_context_get_coap_fd(const coap_context_t *context)
Get the libcoap internal file descriptor for using in an application's select() or returned as an eve...
Definition: net.c:473
int coap_handle_event(coap_context_t *context, coap_event_t event, coap_session_t *session)
Invokes the event handler of context for the given event and data.
Definition: net.c:3352
int coap_context_set_psk(coap_context_t *context, const char *hint, const uint8_t *key, size_t key_len)
Set the context's default PSK hint and/or key for a server.
int coap_mcast_set_hops(coap_session_t *session, size_t hops)
Function interface for defining the hop count (ttl) for sending multicast traffic.
coap_response_t
Definition: net.h:45
void(* coap_ping_handler_t)(coap_session_t *session, const coap_pdu_t *received, const coap_mid_t mid)
Received Ping handler that is used as callback in coap_context_t.
Definition: net.h:86
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
int coap_context_set_pki_root_cas(coap_context_t *context, const char *ca_file, const char *ca_dir)
Set the context's default Root CA information for a client or server.
Definition: net.c:404
void(* coap_nack_handler_t)(coap_session_t *session, const coap_pdu_t *sent, const coap_nack_reason_t reason, const coap_mid_t mid)
Negative Acknowedge handler that is used as callback in coap_context_t.
Definition: net.h:74
COAP_STATIC_INLINE coap_mid_t coap_send_rst(coap_session_t *session, const coap_pdu_t *request)
Sends an RST message with code 0 for the specified request to dst.
Definition: net.h:479
coap_context_t * coap_new_context(const coap_address_t *listen_addr)
Creates a new coap_context_t object that will hold the CoAP stack status.
Definition: net.c:483
coap_mid_t coap_send_message_type(coap_session_t *session, const coap_pdu_t *request, coap_pdu_type_t type)
Helper function to create and send a message with type (usually ACK or RST).
Definition: net.c:929
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context)
Get the CSM max session size value.
Definition: net.c:458
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:469
coap_mid_t coap_send_error(coap_session_t *session, const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Sends an error response with code code for request request to dst.
Definition: net.c:911
int coap_context_set_pki(coap_context_t *context, const coap_dtls_pki_t *setup_data)
Set the context's default PKI information for a server.
void coap_register_ping_handler(coap_context_t *context, coap_ping_handler_t handler)
Registers a new message handler that is called whenever a CoAP Ping message is received.
Definition: net.c:3470
void coap_register_option(coap_context_t *ctx, uint16_t type)
Registers the option type type with the given context object ctx.
Definition: net.c:3482
int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname, const char *ifname)
Function interface for joining a multicast group for listening for the currently defined endpoints th...
void coap_context_set_max_idle_sessions(coap_context_t *context, unsigned int max_idle_sessions)
Set the maximum idle sessions count.
Definition: net.c:418
coap_pdu_t * coap_new_error_response(const coap_pdu_t *request, coap_pdu_code_t code, coap_opt_filter_t *opts)
Creates a new ACK PDU with specified error code.
Definition: net.c:2192
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition: net.c:413
void coap_set_app_data(coap_context_t *context, void *data)
Stores data with the given CoAP context.
Definition: net.c:599
unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition: net.c:446
void coap_register_pong_handler(coap_context_t *context, coap_pong_handler_t handler)
Registers a new message handler that is called whenever a CoAP Pong message is received.
Definition: net.c:3476
coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition: net.c:1113
void coap_register_nack_handler(coap_context_t *context, coap_nack_handler_t handler)
Registers a new message handler that is called whenever a confirmable message (request or response) i...
Definition: net.c:3464
void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_tmeout)
Set the CSM timeout value.
Definition: net.c:440
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition: net.h:46
@ COAP_RESPONSE_OK
Response is fine.
Definition: net.h:47
coap_event_t
Scalar type to represent different events, e.g.
Definition: coap_event.h:34
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: pdu.h:243
coap_pdu_code_t
Set of codes available for a PDU.
Definition: pdu.h:303
coap_pdu_type_t
CoAP PDU message type definitions.
Definition: pdu.h:60
@ COAP_MESSAGE_RST
Definition: pdu.h:64
#define COAP_DEPRECATED
Definition: libcoap.h:53
#define COAP_STATIC_INLINE
Definition: libcoap.h:45
COAP_STATIC_INLINE COAP_DEPRECATED unsigned int coap_write(coap_context_t *ctx, coap_socket_t *sockets[], unsigned int max_sockets, unsigned int *num_sockets, coap_tick_t now)
Definition: net.h:796
COAP_STATIC_INLINE COAP_DEPRECATED int coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
Definition: net.h:772
COAP_STATIC_INLINE COAP_DEPRECATED void coap_read(coap_context_t *ctx, coap_tick_t now)
Definition: net.h:816
Pre-defined constants that reflect defaults for CoAP.
multi-purpose address abstraction
Definition: coap_address.h:96
The CoAP stack's global state is stored in a coap_context_t object.
The structure used for defining the PKI setup data to be used.
Definition: coap_dtls.h:256
The structure used for defining the Server PSK setup data to be used.
Definition: coap_dtls.h:437
structure for CoAP PDUs
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...