libcoap  4.3.0
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  * 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 
12 #ifndef COAP_NET_H_
13 #define COAP_NET_H_
14 
15 #include <stdlib.h>
16 #include <string.h>
17 #ifndef _WIN32
18 #include <sys/time.h>
19 #endif
20 #include <time.h>
21 
22 #ifdef WITH_LWIP
23 #include <lwip/ip_addr.h>
24 #endif
25 
26 #include "coap_io.h"
27 #include "coap_dtls.h"
28 #include "coap_event.h"
29 #include "pdu.h"
30 #include "coap_session.h"
31 
38 typedef enum coap_response_t {
42 
55  const coap_pdu_t *sent,
56  const coap_pdu_t *received,
57  const coap_mid_t mid);
58 
67 typedef void (*coap_nack_handler_t)(coap_session_t *session,
68  const coap_pdu_t *sent,
69  const coap_nack_reason_t reason,
70  const coap_mid_t mid);
71 
79 typedef void (*coap_ping_handler_t)(coap_session_t *session,
80  const coap_pdu_t *received,
81  const coap_mid_t mid);
82 
90 typedef void (*coap_pong_handler_t)(coap_session_t *session,
91  const coap_pdu_t *received,
92  const coap_mid_t mid);
93 
101 void
103  coap_response_handler_t handler);
104 
114 void
116  coap_nack_handler_t handler);
117 
125 void
127  coap_ping_handler_t handler);
128 
136 void
138  coap_pong_handler_t handler);
139 
146 void
147 coap_register_option(coap_context_t *ctx, uint16_t type);
148 
152 coap_context_t *coap_new_context(const coap_address_t *listen_addr);
153 
166 int coap_context_set_psk( coap_context_t *context, const char *hint,
167  const uint8_t *key, size_t key_len );
168 
179  coap_dtls_spsk_t *setup_data);
180 
190 int
192  const coap_dtls_pki_t *setup_data);
193 
205 int
207  const char *ca_file,
208  const char *ca_dir);
209 
226 void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
227 
236 int coap_context_get_coap_fd(const coap_context_t *context);
237 
247 void
249  unsigned int max_idle_sessions);
250 
258 unsigned int
260 
269 void
271  unsigned int session_timeout);
272 
280 unsigned int
282 
291 void
293  unsigned int csm_tmeout);
294 
302 unsigned int
304 
314 void
316  unsigned int max_handshake_sessions);
317 
325 unsigned int
327 
337 uint16_t coap_new_message_id(coap_session_t *session);
338 
347 void coap_free_context(coap_context_t *context);
348 
358 void coap_set_app_data(coap_context_t *context, void *data);
359 
369 void *coap_get_app_data(const coap_context_t *context);
370 
389  coap_pdu_code_t code,
390  coap_opt_filter_t *opts);
391 
408  const coap_pdu_t *request,
409  coap_pdu_code_t code,
410  coap_opt_filter_t *opts);
411 
424 coap_send_message_type(coap_session_t *session, const coap_pdu_t *request,
425  coap_pdu_type_t type);
426 
438 coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request);
439 
452 coap_send_rst(coap_session_t *session, const coap_pdu_t *request) {
453  return coap_send_message_type(session, request, COAP_MESSAGE_RST);
454 }
455 
468 
469 #define coap_send_large(session, pdu) coap_send(session, pdu)
470 
481 int coap_handle_event(coap_context_t *context,
482  coap_event_t event,
483  coap_session_t *session);
487 int coap_can_exit(coap_context_t *context);
488 
494 
506 int
507 coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
508  const char *ifname);
509 
510 #define coap_join_mcast_group(ctx, groupname) \
511  (coap_join_mcast_group_intf(ctx, groupname, NULL))
512 
523 int
524 coap_mcast_set_hops(coap_session_t *session, size_t hops);
525 
534 #define COAP_IO_WAIT 0
535 #define COAP_IO_NO_WAIT ((uint32_t)-1)
536 
565 int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
566 
567 #ifndef RIOT_VERSION
595 int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms,
596  int nfds, fd_set *readfds, fd_set *writefds,
597  fd_set *exceptfds);
598 #endif /* !RIOT_VERSION */
599 
641 unsigned int
643  coap_socket_t *sockets[],
644  unsigned int max_sockets,
645  unsigned int *num_sockets,
646  coap_tick_t now
647 );
648 
663 
683 unsigned int
685 
686 struct epoll_event;
687 
701 void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event* events,
702  size_t nevents);
703 
726 coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
727 {
728  return coap_io_process(ctx, timeout_ms);
729 }
730 
751  coap_socket_t *sockets[],
752  unsigned int max_sockets,
753  unsigned int *num_sockets,
754  coap_tick_t now
755 ) {
756  return coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now);
757 }
758 
771 ) {
772  coap_io_do_io(ctx, now);
773 }
774 
775 /* Old definitions which may be hanging around in old code - be helpful! */
776 #define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
777 #define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
778 
779 #endif /* COAP_NET_H_ */
coap_nack_reason_t
Definition: coap_io.h:64
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:1738
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:1007
void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition: net.c:1799
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:1059
int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition: coap_io.c:1261
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:1266
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:122
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:752
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition: net.c:485
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:408
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:469
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:90
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition: net.c:458
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:3174
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:54
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:3250
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:625
void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition: net.c:631
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:463
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:495
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:3163
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:388
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:3503
coap_response_t
Definition: net.h:38
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:79
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:437
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:67
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:452
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:505
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:920
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition: net.c:491
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:902
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:422
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:3262
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:3274
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:3280
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:452
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:2057
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition: net.c:447
void coap_set_app_data(coap_context_t *context, void *data)
Stores data with the given CoAP context.
Definition: net.c:619
unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition: net.c:480
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:3268
coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition: net.c:1057
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:3256
void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_tmeout)
Set the CSM timeout value.
Definition: net.c:474
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition: net.h:39
@ COAP_RESPONSE_OK
Response is fine.
Definition: net.h:40
unsigned int coap_event_t
Scalar type to represent different events, e.g.
Definition: coap_event.h:27
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: pdu.h:231
coap_pdu_code_t
Set of codes available for a PDU.
Definition: pdu.h:291
coap_pdu_type_t
CoAP PDU message type definitions.
Definition: pdu.h:56
@ COAP_MESSAGE_RST
Definition: pdu.h:60
#define COAP_DEPRECATED
Definition: libcoap.h:48
#define COAP_STATIC_INLINE
Definition: libcoap.h:40
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:750
COAP_STATIC_INLINE COAP_DEPRECATED int coap_run_once(coap_context_t *ctx, uint32_t timeout_ms)
Definition: net.h:726
COAP_STATIC_INLINE COAP_DEPRECATED void coap_read(coap_context_t *ctx, coap_tick_t now)
Definition: net.h:770
Pre-defined constants that reflect defaults for CoAP.
multi-purpose address abstraction
Definition: 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:244
The structure used for defining the Server PSK setup data to be used.
Definition: coap_dtls.h:425
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...