libcoap  4.3.0rc3
net.h
Go to the documentation of this file.
1 /*
2  * net.h -- CoAP network interface
3  *
4  * Copyright (C) 2010-2021 Olaf Bergmann <bergmann@tzi.org>
5  *
6  * This file is part of the CoAP library libcoap. Please see README for terms
7  * of use.
8  */
9 
10 #ifndef COAP_NET_H_
11 #define COAP_NET_H_
12 
13 #include <stdlib.h>
14 #include <string.h>
15 #ifndef _WIN32
16 #include <sys/time.h>
17 #endif
18 #include <time.h>
19 
20 #ifdef WITH_LWIP
21 #include <lwip/ip_addr.h>
22 #endif
23 
24 #include "coap_io.h"
25 #include "coap_dtls.h"
26 #include "coap_event.h"
27 #include "pdu.h"
28 #include "coap_session.h"
29 
36 typedef enum coap_response_t {
40 
53  const coap_pdu_t *sent,
54  const coap_pdu_t *received,
55  const coap_mid_t mid);
56 
65 typedef void (*coap_nack_handler_t)(coap_session_t *session,
66  const coap_pdu_t *sent,
67  const coap_nack_reason_t reason,
68  const coap_mid_t mid);
69 
77 typedef void (*coap_ping_handler_t)(coap_session_t *session,
78  const coap_pdu_t *received,
79  const coap_mid_t mid);
80 
88 typedef void (*coap_pong_handler_t)(coap_session_t *session,
89  const coap_pdu_t *received,
90  const coap_mid_t mid);
91 
99 void
101  coap_response_handler_t handler);
102 
112 void
114  coap_nack_handler_t handler);
115 
123 void
125  coap_ping_handler_t handler);
126 
134 void
136  coap_pong_handler_t handler);
137 
144 void
145 coap_register_option(coap_context_t *ctx, uint16_t type);
146 
150 coap_context_t *coap_new_context(const coap_address_t *listen_addr);
151 
164 int coap_context_set_psk( coap_context_t *context, const char *hint,
165  const uint8_t *key, size_t key_len );
166 
177  coap_dtls_spsk_t *setup_data);
178 
188 int
190  const coap_dtls_pki_t *setup_data);
191 
203 int
205  const char *ca_file,
206  const char *ca_dir);
207 
224 void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
225 
234 int coap_context_get_coap_fd(const coap_context_t *context);
235 
245 void
247  unsigned int max_idle_sessions);
248 
256 unsigned int
258 
267 void
269  unsigned int session_timeout);
270 
278 unsigned int
280 
289 void
291  unsigned int csm_tmeout);
292 
300 unsigned int
302 
312 void
314  unsigned int max_handshake_sessions);
315 
323 unsigned int
325 
335 uint16_t coap_new_message_id(coap_session_t *session);
336 
345 void coap_free_context(coap_context_t *context);
346 
356 void coap_set_app_data(coap_context_t *context, void *data);
357 
367 void *coap_get_app_data(const coap_context_t *context);
368 
387  coap_pdu_code_t code,
388  coap_opt_filter_t *opts);
389 
406  const coap_pdu_t *request,
407  coap_pdu_code_t code,
408  coap_opt_filter_t *opts);
409 
422 coap_send_message_type(coap_session_t *session, const coap_pdu_t *request,
423  coap_pdu_type_t type);
424 
436 coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request);
437 
450 coap_send_rst(coap_session_t *session, const coap_pdu_t *request) {
451  return coap_send_message_type(session, request, COAP_MESSAGE_RST);
452 }
453 
466 
483 
494 int coap_handle_event(coap_context_t *context,
495  coap_event_t event,
496  coap_session_t *session);
500 int coap_can_exit(coap_context_t *context);
501 
507 
519 int
520 coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
521  const char *ifname);
522 
523 #define coap_join_mcast_group(ctx, groupname) \
524  (coap_join_mcast_group_intf(ctx, groupname, NULL))
525 
536 int
537 coap_mcast_set_hops(coap_session_t *session, size_t hops);
538 
547 #define COAP_IO_WAIT 0
548 #define COAP_IO_NO_WAIT ((uint32_t)-1)
549 
578 int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
579 
580 #ifndef RIOT_VERSION
608 int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms,
609  int nfds, fd_set *readfds, fd_set *writefds,
610  fd_set *exceptfds);
611 #endif /* !RIOT_VERSION */
612 
654 unsigned int
656  coap_socket_t *sockets[],
657  unsigned int max_sockets,
658  unsigned int *num_sockets,
659  coap_tick_t now
660 );
661 
676 
696 unsigned int
698 
699 struct epoll_event;
700 
714 void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event* events,
715  size_t nevents);
716 
739 coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
740 {
741  return coap_io_process(ctx, timeout_ms);
742 }
743 
764  coap_socket_t *sockets[],
765  unsigned int max_sockets,
766  unsigned int *num_sockets,
767  coap_tick_t now
768 ) {
769  return coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now);
770 }
771 
784 ) {
785  coap_io_do_io(ctx, now);
786 }
787 
788 /* Old definitions which may be hanging around in old code - be helpful! */
789 #define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
790 #define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
791 
792 #endif /* COAP_NET_H_ */
coap_nack_reason_t
Definition: coap_io.h:62
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:1739
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:1005
void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition: net.c:1800
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:1057
int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition: coap_io.c:1259
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:1264
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:120
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:750
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition: net.c:483
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.
Definition: net.c:406
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:467
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:88
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition: net.c:456
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:3182
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:52
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:3258
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:623
void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition: net.c:629
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:461
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:493
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:3171
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.
Definition: net.c:386
int coap_mcast_set_hops(coap_session_t *session, size_t hops)
Function interface for defining the hop count (ttl) for sending multicast traffic.
Definition: net.c:3511
coap_response_t
Definition: net.h:36
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:77
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:435
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:65
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:450
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:503
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:918
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:489
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:900
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.
Definition: net.c:420
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:3270
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:3282
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...
Definition: net.c:3288
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:450
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:2058
coap_mid_t coap_send_large(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition: net.c:1055
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition: net.c:445
void coap_set_app_data(coap_context_t *context, void *data)
Stores data with the given CoAP context.
Definition: net.c:617
unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition: net.c:478
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:3276
coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition: net.c:1155
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:3264
void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_tmeout)
Set the CSM timeout value.
Definition: net.c:472
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition: net.h:37
@ COAP_RESPONSE_OK
Response is fine.
Definition: net.h:38
unsigned int coap_event_t
Scalar type to represent different events, e.g.
Definition: coap_event.h:25
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: pdu.h:229
coap_pdu_code_t
Set of codes available for a PDU.
Definition: pdu.h:289
coap_pdu_type_t
CoAP PDU message type definitions.
Definition: pdu.h:54
@ COAP_MESSAGE_RST
Definition: pdu.h:58
#define COAP_DEPRECATED
Definition: libcoap.h:46
#define COAP_STATIC_INLINE
Definition: libcoap.h:38
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:763
COAP_STATIC_INLINE COAP_DEPRECATED int coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
Definition: net.h:739
COAP_STATIC_INLINE COAP_DEPRECATED void coap_read(coap_context_t *ctx, coap_tick_t now)
Definition: net.h:783
Pre-defined constants that reflect defaults for CoAP.
multi-purpose address abstraction
Definition: address.h:94
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:242
The structure used for defining the Server PSK setup data to be used.
Definition: coap_dtls.h:423
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...