libcoap 4.3.5rc1
Loading...
Searching...
No Matches
coap_net.h
Go to the documentation of this file.
1/*
2 * coap_net.h -- CoAP context interface
3 *
4 * Copyright (C) 2010-2024 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#ifdef HAVE_SYS_SELECT_H
24#include <sys/select.h>
25#endif /* HAVE_SYS_SELECT_H */
26#include <sys/time.h>
27#endif
28#include <time.h>
29
30#ifdef WITH_LWIP
31#include <lwip/ip_addr.h>
32#endif
33
34#include "coap_io.h"
35#include "coap_dtls.h"
36#include "coap_event.h"
37#include "coap_pdu.h"
38#include "coap_session.h"
39#include "coap_debug.h"
40
52
65 const coap_pdu_t *sent,
66 const coap_pdu_t *received,
67 const coap_mid_t mid);
68
77typedef void (*coap_nack_handler_t)(coap_session_t *session,
78 const coap_pdu_t *sent,
79 const coap_nack_reason_t reason,
80 const coap_mid_t mid);
81
89typedef void (*coap_ping_handler_t)(coap_session_t *session,
90 const coap_pdu_t *received,
91 const coap_mid_t mid);
92
100typedef void (*coap_pong_handler_t)(coap_session_t *session,
101 const coap_pdu_t *received,
102 const coap_mid_t mid);
103
113
124 coap_nack_handler_t handler);
125
134 coap_ping_handler_t handler);
135
144 coap_pong_handler_t handler);
145
152COAP_API void coap_register_option(coap_context_t *ctx, uint16_t type);
153
158
173COAP_API 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
198 const coap_dtls_pki_t *setup_data);
199
212 const char *ca_file,
213 const char *ca_dir);
214
231void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
232
241 size_t max_token_size);
242
251int coap_context_get_coap_fd(const coap_context_t *context);
252
263 unsigned int max_idle_sessions);
264
272unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context);
273
283 unsigned int session_timeout);
284
292unsigned int coap_context_get_session_timeout(const coap_context_t *context);
293
305 unsigned int csm_timeout);
306
317
328 unsigned int csm_timeout_ms);
329
337unsigned int coap_context_get_csm_timeout_ms(const coap_context_t *context);
338
346 uint32_t csm_max_message_size);
347
356
367 unsigned int max_handshake_sessions);
368
377
388
398
410void coap_set_app_data(coap_context_t *context, void *data);
411
423void *coap_get_app_data(const coap_context_t *context);
424
443 coap_pdu_code_t code,
444 coap_opt_filter_t *opts);
445
462 const coap_pdu_t *request,
463 coap_pdu_code_t code,
464 coap_opt_filter_t *opts);
465
478 coap_pdu_type_t type);
479
492
505
518
519#define coap_send_large(session, pdu) coap_send(session, pdu)
520
532 coap_event_t event,
533 coap_session_t *session);
545
551
563COAP_API int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
564 const char *ifname);
565
566#define coap_join_mcast_group(ctx, groupname) \
567 (coap_join_mcast_group_intf(ctx, groupname, NULL))
568
579int coap_mcast_set_hops(coap_session_t *session, size_t hops);
580
589
597void coap_context_set_app_data(coap_context_t *context, void *data);
598
608void *coap_context_get_app_data(const coap_context_t *context);
609
619#define COAP_IO_WAIT 0
620#define COAP_IO_NO_WAIT ((uint32_t)-1)
621
650COAP_API int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
651
652#if !defined(RIOT_VERSION) && !defined(WITH_CONTIKI)
680COAP_API int coap_io_process_with_fds(coap_context_t *ctx, uint32_t timeout_ms,
681 int nfds, fd_set *readfds, fd_set *writefds,
682 fd_set *exceptfds);
683#endif /* ! RIOT_VERSION && ! WITH_CONTIKI */
684
698
733 coap_socket_t *sockets[],
734 unsigned int max_sockets,
735 unsigned int *num_sockets,
736 coap_tick_t now
737 );
738
753
774
775struct epoll_event;
776
790COAP_API void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events,
791 size_t nevents);
792
812
824typedef int (*coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs);
825
837 void *input_arg);
838
860#define coap_run_once(ctx, timeout_ms) coap_io_process(ctx, timeout_ms)
861
880#define coap_write(ctx, sockets, max_sockets, num_sockets, now) \
881 coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now)
882
893#define coap_read(ctx, now) coap_io_do_io(ctx, now)
894
895/* Old definitions which may be hanging around in old code - be helpful! */
896#define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
897#define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
898
899#endif /* COAP_NET_H_ */
CoAP Logging support.
CoAP DTLS support.
Event handling.
Default network I/O functions.
coap_nack_reason_t
Definition coap_io.h:69
#define COAP_API
Pre-defined constants that reflect defaults for CoAP.
Defines the application visible session information.
COAP_API int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms)
The main I/O processing function.
Definition coap_io.c:1516
COAP_API int coap_io_pending(coap_context_t *context)
Check to see if there is any i/o pending for the context.
Definition coap_io.c:1760
COAP_API 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:1244
COAP_API 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:1183
COAP_API 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:1531
COAP_API void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events, size_t nevents)
Process all the epoll events.
Definition coap_net.c:2306
COAP_API 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 coap_net.c:2245
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
void coap_context_set_session_timeout(coap_context_t *context, unsigned int session_timeout)
Set the session timeout value.
Definition coap_net.c:534
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:487
COAP_API 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_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 coap_net.h:100
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context)
Get the maximum idle sessions count.
Definition coap_net.c:476
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 coap_net.c:567
COAP_API coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu)
Sends a CoAP message to given peer.
Definition coap_net.c:1245
COAP_API 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_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 coap_net.h:64
COAP_API 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 coap_net.c:980
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 coap_net.c:522
COAP_DEPRECATED void coap_context_set_csm_timeout(coap_context_t *context, unsigned int csm_timeout)
Set the CSM timeout value.
Definition coap_net.c:494
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 coap_net.c:4410
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 coap_net.c:2588
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 coap_net.c:481
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 coap_net.c:545
int coap_mcast_set_hops(coap_session_t *session, size_t hops)
Function interface for defining the hop count (ttl) for sending multicast traffic.
void coap_context_set_app_data(coap_context_t *context, void *data)
Stores data with the given context.
Definition coap_net.c:555
coap_response_t
Definition coap_net.h:48
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 coap_net.h:89
void coap_ticks(coap_tick_t *)
Returns the current value of an internal tick counter.
COAP_API void coap_free_context(coap_context_t *context)
CoAP stack context must be released with coap_free_context().
Definition coap_net.c:672
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 coap_net.h:77
void * coap_context_get_app_data(const coap_context_t *context)
Returns any application-specific data that has been stored with context using the function coap_conte...
Definition coap_net.c:561
COAP_API 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 coap_net.c:435
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context)
Get the CSM max session size value.
Definition coap_net.c:529
unsigned int coap_context_get_session_timeout(const coap_context_t *context)
Get the session timeout value.
Definition coap_net.c:540
COAP_API 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.
COAP_API void coap_register_option(coap_context_t *ctx, uint16_t type)
Registers the option type type with the given context object ctx.
Definition coap_net.c:4439
COAP_API 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 coap_net.c:903
unsigned int coap_context_get_csm_timeout_ms(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:517
COAP_API uint16_t coap_new_message_id(coap_session_t *session)
Returns a new message id and updates session->tx_mid accordingly.
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 coap_net.c:4427
COAP_API 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.
void * coap_get_app_data(const coap_context_t *context)
Definition coap_net.c:666
void coap_context_set_max_idle_sessions(coap_context_t *context, unsigned int max_idle_sessions)
Set the maximum idle sessions count.
Definition coap_net.c:470
COAP_API 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 coap_net.c:1011
COAP_API 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 coap_net.c:888
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds)
Set the context keepalive timer for sessions.
Definition coap_net.c:457
void coap_set_app_data(coap_context_t *context, void *data)
Definition coap_net.c:660
COAP_API 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 coap_net.c:4267
COAP_DEPRECATED unsigned int coap_context_get_csm_timeout(const coap_context_t *context)
Get the CSM timeout value.
Definition coap_net.c:501
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 coap_net.c:4433
void coap_context_set_max_token_size(coap_context_t *context, size_t max_token_size)
Set the maximum token size (RFC8974).
Definition coap_net.c:462
COAP_API 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 coap_net.c:4242
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 coap_net.c:4421
void coap_context_set_csm_timeout_ms(coap_context_t *context, unsigned int csm_timeout_ms)
Set the CSM timeout value.
Definition coap_net.c:507
@ COAP_RESPONSE_FAIL
Response not liked - send CoAP RST packet.
Definition coap_net.h:49
@ COAP_RESPONSE_OK
Response is fine.
Definition coap_net.h:50
coap_event_t
Scalar type to represent different events, e.g.
Definition coap_event.h:34
coap_log_t
Logging type.
Definition coap_debug.h:50
void coap_lwip_set_input_wait_handler(coap_context_t *context, coap_lwip_input_wait_handler_t handler, void *input_arg)
Set up a wait / timeout callback handler for use when the application calls coap_io_process().
int(* coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs)
LwIP callback handler that can be used to wait / timeout for the next input packet.
Definition coap_net.h:824
void coap_lwip_dump_memory_pools(coap_log_t log_level)
Dump the current state of the LwIP memory pools.
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition coap_pdu.h:263
coap_pdu_code_t
Set of codes available for a PDU.
Definition coap_pdu.h:326
coap_pdu_type_t
CoAP PDU message type definitions.
Definition coap_pdu.h:68
#define COAP_DEPRECATED
Definition libcoap.h:62
Multi-purpose address abstraction.
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:354
The structure used for defining the Server PSK setup data to be used.
Definition coap_dtls.h:535
structure for CoAP PDUs
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...