coap_net_internal.h

Go to the documentation of this file.

/*
 * coap_net_internal.h -- CoAP context internal information
 * exposed to application programming
 *
 * 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_INTERNAL_H_
#define COAP_NET_INTERNAL_H_
 
#include "coap_internal.h"
#include "coap_subscribe.h"
 
struct coap_queue_t {
  struct coap_queue_t *next;
  coap_tick_t t;                
  unsigned char retransmit_cnt; 
  uint8_t is_mcast;             
  unsigned int timeout;         
  coap_session_t *session;      
  coap_mid_t id;                
  coap_pdu_t *pdu;              
};
 
struct coap_context_t {
  coap_opt_filter_t known_options;
#if COAP_SERVER_SUPPORT
  coap_resource_t *resources; 
  coap_resource_t *unknown_resource; 
  coap_resource_t *proxy_uri_resource; 
  coap_resource_release_userdata_handler_t release_userdata;
#endif /* COAP_SERVER_SUPPORT */
 
#if COAP_ASYNC_SUPPORT
  coap_async_t *async_state;
#endif /* COAP_ASYNC_SUPPORT */
 
  coap_tick_t sendqueue_basetime;
  coap_queue_t *sendqueue;
#if COAP_SERVER_SUPPORT
  coap_endpoint_t *endpoint;      
#endif /* COAP_SERVER_SUPPORT */
#if COAP_CLIENT_SUPPORT
  coap_session_t *sessions;       
#endif /* COAP_CLIENT_SUPPORT */
 
#ifdef WITH_CONTIKI
  struct uip_udp_conn *conn;      
  struct ctimer prepare_timer;    
#endif /* WITH_CONTIKI */
 
#ifdef WITH_LWIP
  coap_lwip_input_wait_handler_t input_wait; 
  void *input_arg;                
  uint8_t timer_configured;       
#endif /* WITH_LWIP */
#if COAP_OSCORE_SUPPORT
  struct oscore_ctx_t *p_osc_ctx; 
#endif /* COAP_OSCORE_SUPPORT */
 
#if COAP_CLIENT_SUPPORT
  coap_response_handler_t response_handler; 
#endif /* COAP_CLIENT_SUPPORT */
  coap_nack_handler_t nack_handler; 
  coap_ping_handler_t ping_handler; 
  coap_pong_handler_t pong_handler; 
#if COAP_SERVER_SUPPORT
  coap_observe_added_t observe_added; 
  coap_observe_deleted_t observe_deleted; 
  void *observe_user_data; 
  uint32_t observe_save_freq; 
  coap_track_observe_value_t track_observe_value; 
  coap_dyn_resource_added_t dyn_resource_added; 
  coap_resource_deleted_t resource_deleted; 
#if COAP_WITH_OBSERVE_PERSIST
  coap_bin_const_t *dyn_resource_save_file; 
  coap_bin_const_t *obs_cnt_save_file; 
  coap_bin_const_t *observe_save_file; 
  coap_pdu_t *unknown_pdu;        
  coap_session_t *unknown_session; 
#endif /* COAP_WITH_OBSERVE_PERSIST */
#endif /* COAP_SERVER_SUPPORT */
 
  coap_event_handler_t handle_event;
 
  void *dtls_context;
 
#if COAP_SERVER_SUPPORT
  coap_dtls_spsk_t spsk_setup_data;  
#endif /* COAP_SERVER_SUPPORT */
 
  unsigned int session_timeout;    
  unsigned int max_idle_sessions;  
  unsigned int max_handshake_sessions; 
  unsigned int ping_timeout;           
  unsigned int csm_timeout;           
  uint32_t csm_max_message_size;   
  uint64_t etag;                   
#if COAP_SERVER_SUPPORT
  coap_cache_entry_t *cache;       
  uint16_t *cache_ignore_options;  
  size_t cache_ignore_count;       
#endif /* COAP_SERVER_SUPPORT */
  void *app;                       
  uint32_t max_token_size;         
#ifdef COAP_EPOLL_SUPPORT
  int epfd;                        
  int eptimerfd;                   
  coap_tick_t next_timeout;        
#else /* ! COAP_EPOLL_SUPPORT */
  fd_set readfds, writefds, exceptfds; 
  coap_socket_t *sockets[64];      
  unsigned int num_sockets;        
#endif /* ! COAP_EPOLL_SUPPORT */
#if COAP_SERVER_SUPPORT
  uint8_t observe_pending;         
  uint8_t observe_no_clear;        
  uint8_t mcast_per_resource;      
#endif /* COAP_SERVER_SUPPORT */
  uint8_t block_mode;              
};
 
int coap_insert_node(coap_queue_t **queue, coap_queue_t *node);
 
int coap_delete_node(coap_queue_t *node);
 
void coap_delete_all(coap_queue_t *queue);
 
coap_queue_t *coap_new_node(void);
 
unsigned int coap_adjust_basetime(coap_context_t *ctx, coap_tick_t now);
 
coap_queue_t *coap_peek_next(coap_context_t *context);
 
coap_queue_t *coap_pop_next(coap_context_t *context);
 
coap_mid_t coap_retransmit(coap_context_t *context, coap_queue_t *node);
 
int coap_handle_dgram(coap_context_t *ctx, coap_session_t *session, uint8_t *data, size_t data_len);
 
int coap_remove_from_queue(coap_queue_t **queue,
                           coap_session_t *session,
                           coap_mid_t id,
                           coap_queue_t **node);
 
coap_mid_t coap_wait_ack(coap_context_t *context, coap_session_t *session,
                         coap_queue_t *node);
 
void coap_cancel_all_messages(coap_context_t *context,
                              coap_session_t *session,
                              coap_bin_const_t *token);
 
void coap_cancel_session_messages(coap_context_t *context,
                                  coap_session_t *session,
                                  coap_nack_reason_t reason);
 
void coap_dispatch(coap_context_t *context, coap_session_t *session,
                   coap_pdu_t *pdu);
 
int coap_option_check_critical(coap_session_t *session,
                               coap_pdu_t *pdu,
                               coap_opt_filter_t *unknown);
 
coap_pdu_t *coap_wellknown_response(coap_context_t *context,
                                    coap_session_t *session,
                                    coap_pdu_t *request);
 
unsigned int coap_calc_timeout(coap_session_t *session, unsigned char r);
 
coap_mid_t coap_send_internal(coap_session_t *session, coap_pdu_t *pdu);
 
int coap_client_delay_first(coap_session_t *session);
 
extern int coap_started;
 
#endif /* COAP_NET_INTERNAL_H_ */