coap_net.h

Go to the documentation of this file.

/*
 * coap_net.h -- CoAP context interface
 *
 * Copyright (C) 2010-2023 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_NET_H_
#define COAP_NET_H_
 
#include <stdlib.h>
#include <string.h>
#ifndef _WIN32
#include <sys/select.h>
#include <sys/time.h>
#endif
#include <time.h>
 
#ifdef WITH_LWIP
#include <lwip/ip_addr.h>
#endif
 
#include "coap_io.h"
#include "coap_dtls.h"
#include "coap_event.h"
#include "coap_pdu.h"
#include "coap_session.h"
#include "coap_debug.h"
 
typedef enum coap_response_t {
  COAP_RESPONSE_FAIL, 
  COAP_RESPONSE_OK    
} coap_response_t;
 
typedef 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);
 
typedef 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);
 
typedef void (*coap_ping_handler_t)(coap_session_t *session,
                                    const coap_pdu_t *received,
                                    const coap_mid_t mid);
 
typedef void (*coap_pong_handler_t)(coap_session_t *session,
                                    const coap_pdu_t *received,
                                    const coap_mid_t mid);
 
void coap_register_response_handler(coap_context_t *context,
                                    coap_response_handler_t handler);
 
void coap_register_nack_handler(coap_context_t *context,
                                coap_nack_handler_t handler);
 
void coap_register_ping_handler(coap_context_t *context,
                                coap_ping_handler_t handler);
 
void coap_register_pong_handler(coap_context_t *context,
                                coap_pong_handler_t handler);
 
void coap_register_option(coap_context_t *ctx, uint16_t type);
 
coap_context_t *coap_new_context(const coap_address_t *listen_addr);
 
int coap_context_set_psk(coap_context_t *context, const char *hint,
                         const uint8_t *key, size_t key_len);
 
int coap_context_set_psk2(coap_context_t *context,
                          coap_dtls_spsk_t *setup_data);
 
int coap_context_set_pki(coap_context_t *context,
                         const coap_dtls_pki_t *setup_data);
 
int coap_context_set_pki_root_cas(coap_context_t *context,
                                  const char *ca_file,
                                  const char *ca_dir);
 
void coap_context_set_keepalive(coap_context_t *context, unsigned int seconds);
 
void coap_context_set_max_token_size(coap_context_t *context,
                                     size_t max_token_size);
 
int coap_context_get_coap_fd(const coap_context_t *context);
 
void coap_context_set_max_idle_sessions(coap_context_t *context,
                                        unsigned int max_idle_sessions);
 
unsigned int coap_context_get_max_idle_sessions(const coap_context_t *context);
 
void coap_context_set_session_timeout(coap_context_t *context,
                                      unsigned int session_timeout);
 
unsigned int coap_context_get_session_timeout(const coap_context_t *context);
 
void coap_context_set_csm_timeout(coap_context_t *context,
                                  unsigned int csm_tmeout);
 
unsigned int coap_context_get_csm_timeout(const coap_context_t *context);
 
void coap_context_set_csm_max_message_size(coap_context_t *context,
                                           uint32_t csm_max_message_size);
 
uint32_t coap_context_get_csm_max_message_size(const coap_context_t *context);
 
void coap_context_set_max_handshake_sessions(coap_context_t *context,
                                             unsigned int max_handshake_sessions);
 
unsigned int coap_context_get_max_handshake_sessions(const coap_context_t *context);
 
uint16_t coap_new_message_id(coap_session_t *session);
 
void coap_free_context(coap_context_t *context);
 
void coap_set_app_data(coap_context_t *context, void *data);
 
void *coap_get_app_data(const coap_context_t *context);
 
coap_pdu_t *coap_new_error_response(const coap_pdu_t *request,
                                    coap_pdu_code_t code,
                                    coap_opt_filter_t *opts);
 
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);
 
coap_mid_t coap_send_message_type(coap_session_t *session, const coap_pdu_t *request,
                                  coap_pdu_type_t type);
 
coap_mid_t coap_send_ack(coap_session_t *session, const coap_pdu_t *request);
 
COAP_STATIC_INLINE coap_mid_t
coap_send_rst(coap_session_t *session, const coap_pdu_t *request) {
  return coap_send_message_type(session, request, COAP_MESSAGE_RST);
}
 
coap_mid_t coap_send(coap_session_t *session, coap_pdu_t *pdu);
 
#define coap_send_large(session, pdu) coap_send(session, pdu)
 
int coap_handle_event(coap_context_t *context,
                      coap_event_t event,
                      coap_session_t *session);
int coap_can_exit(coap_context_t *context);
 
void coap_ticks(coap_tick_t *);
 
int coap_join_mcast_group_intf(coap_context_t *ctx, const char *groupname,
                               const char *ifname);
 
#define coap_join_mcast_group(ctx, groupname) \
  (coap_join_mcast_group_intf(ctx, groupname, NULL))
 
int coap_mcast_set_hops(coap_session_t *session, size_t hops);
 
void coap_mcast_per_resource(coap_context_t *context);
 
#define COAP_IO_WAIT    0
#define COAP_IO_NO_WAIT ((uint32_t)-1)
 
int coap_io_process(coap_context_t *ctx, uint32_t timeout_ms);
 
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);
 
int coap_io_pending(coap_context_t *context);
 
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
                               );
 
void coap_io_do_io(coap_context_t *ctx, coap_tick_t now);
 
unsigned int coap_io_prepare_epoll(coap_context_t *ctx, coap_tick_t now);
 
struct epoll_event;
 
void coap_io_do_epoll(coap_context_t *ctx, struct epoll_event *events,
                      size_t nevents);
 
void coap_lwip_dump_memory_pools(coap_log_t log_level);
 
typedef int (*coap_lwip_input_wait_handler_t)(void *arg, uint32_t milli_secs);
 
void coap_lwip_set_input_wait_handler(coap_context_t *context,
                                      coap_lwip_input_wait_handler_t handler,
                                      void *input_arg);
 
COAP_STATIC_INLINE COAP_DEPRECATED int
coap_run_once(coap_context_t *ctx, uint32_t timeout_ms) {
  return coap_io_process(ctx, timeout_ms);
}
 
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
          ) {
  return coap_io_prepare_io(ctx, sockets, max_sockets, num_sockets, now);
}
 
COAP_STATIC_INLINE COAP_DEPRECATED void
coap_read(coap_context_t *ctx, coap_tick_t now
         ) {
  coap_io_do_io(ctx, now);
}
 
/* Old definitions which may be hanging around in old code - be helpful! */
#define COAP_RUN_NONBLOCK COAP_RUN_NONBLOCK_deprecated_use_COAP_IO_NO_WAIT
#define COAP_RUN_BLOCK COAP_RUN_BLOCK_deprecated_use_COAP_IO_WAIT
 
#endif /* COAP_NET_H_ */