mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-11 03:10:40 +03:00
Jon Shallow
0c3928f536
Move coap_session_t and coap_addr_hash_t to coap_session_internal.h. Move internal session based function definitions to coap_session_internal.h. Replace most references to "struct coap_session_t" with "coap_session_t". Provide new functions to allow applications to access parts of coap_session_t as appropriate and document these functions. Update examples to use these new access functions where appropriate. For the man documentation, move the client session setup functions to (new) coap_endpoint_client(3) and update coap_session(3) with all the session access functions as these are common to both the client and server. [coap_endpoint_server(3) will be created when coap_context_t is obfuscated.]
87 lines
2.1 KiB
C
87 lines
2.1 KiB
C
/*
|
|
* coap_forward_decls.h -- Forward declarations of structures that are
|
|
* opaque to application programming that use libcoap.
|
|
*
|
|
* Copyright (C) 2019-2021 Jon Shallow <supjps-libcoap@jpshallow.com>
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
/**
|
|
* @file coap_forward_decls.h
|
|
* @brief COAP forward definitions
|
|
*/
|
|
|
|
#ifndef COAP_FORWARD_DECLS_H_
|
|
#define COAP_FORWARD_DECLS_H_
|
|
|
|
/*
|
|
* Define the forward declations for the structures (even non-opaque)
|
|
* so that applications (using coap.h) as well as libcoap builds
|
|
* can reference them (and makes .h file dependencies a lot simpler).
|
|
*/
|
|
struct coap_address_t;
|
|
struct coap_bin_const_t;
|
|
struct coap_dtls_pki_t;
|
|
struct coap_packet_t;
|
|
struct coap_queue_t;
|
|
struct coap_str_const_t;
|
|
struct coap_string_t;
|
|
|
|
/*
|
|
* Just to get rid of #include circular references
|
|
*
|
|
* When (If) the struct becomes opaque, then move it to the correct place
|
|
*
|
|
*/
|
|
typedef struct coap_pdu_t coap_pdu_t;
|
|
typedef struct coap_context_t coap_context_t;
|
|
|
|
/*
|
|
* typedef all the opaque structures that are defined in coap_*_internal.h
|
|
*/
|
|
|
|
/* ************* coap_cache_internal.h ***************** */
|
|
|
|
/*
|
|
* Cache Entry information.
|
|
*/
|
|
typedef struct coap_cache_entry_t coap_cache_entry_t;
|
|
typedef struct coap_cache_key_t coap_cache_key_t;
|
|
|
|
/* ************* coap_block_internal.h ***************** */
|
|
|
|
/*
|
|
* Block handling information.
|
|
*/
|
|
typedef struct coap_lg_xmit_t coap_lg_xmit_t;
|
|
typedef struct coap_lg_crcv_t coap_lg_crcv_t;
|
|
typedef struct coap_lg_srcv_t coap_lg_srcv_t;
|
|
|
|
/* ************* coap_resource_internal.h ***************** */
|
|
|
|
/*
|
|
* Resource information.
|
|
*/
|
|
typedef struct coap_attr_t coap_attr_t;
|
|
typedef struct coap_resource_t coap_resource_t;
|
|
|
|
/* ************* coap_session_internal.h ***************** */
|
|
|
|
/*
|
|
* Session information.
|
|
*/
|
|
typedef struct coap_addr_hash_t coap_addr_hash_t;
|
|
typedef struct coap_endpoint_t coap_endpoint_t;
|
|
typedef struct coap_session_t coap_session_t;
|
|
|
|
/* ************* coap_subscribe_internal.h ***************** */
|
|
|
|
/*
|
|
* Observe subscriber information.
|
|
*/
|
|
typedef struct coap_subscription_t coap_subscription_t;
|
|
|
|
#endif /* COAP_FORWARD_DECLS_H_ */
|