libcoap  4.3.0rc3
coap_forward_decls.h
Go to the documentation of this file.
1 /*
2  * coap_forward_decls.h -- Forward declarations of structures that are
3  * opaque to application programming that use libcoap.
4  *
5  * Copyright (C) 2019-2021 Jon Shallow <supjps-libcoap@jpshallow.com>
6  *
7  * This file is part of the CoAP library libcoap. Please see README for terms
8  * of use.
9  */
10 
16 #ifndef COAP_FORWARD_DECLS_H_
17 #define COAP_FORWARD_DECLS_H_
18 
19 /*
20  * Define the forward declations for the structures (even non-opaque)
21  * so that applications (using coap.h) as well as libcoap builds
22  * can reference them (and makes .h file dependencies a lot simpler).
23  */
24 struct coap_address_t;
25 struct coap_bin_const_t;
26 struct coap_dtls_pki_t;
27 struct coap_str_const_t;
28 struct coap_string_t;
29 
30 /*
31  * typedef all the opaque structures that are defined in coap_*_internal.h
32  */
33 
34 /* ************* coap_async_internal.h ***************** */
35 
39 typedef struct coap_async_t coap_async_t;
40 
41 /* ************* coap_block_internal.h ***************** */
42 
43 /*
44  * Block handling information.
45  */
46 typedef struct coap_lg_xmit_t coap_lg_xmit_t;
47 typedef struct coap_lg_crcv_t coap_lg_crcv_t;
48 typedef struct coap_lg_srcv_t coap_lg_srcv_t;
49 
50 /* ************* coap_cache_internal.h ***************** */
51 
52 /*
53  * Cache Entry information.
54  */
56 typedef struct coap_cache_key_t coap_cache_key_t;
57 
58 /* ************* coap_io_internal.h ***************** */
59 
63 typedef struct coap_packet_t coap_packet_t;
64 typedef struct coap_socket_t coap_socket_t;
65 
66 /* ************* coap_net_internal.h ***************** */
67 
68 /*
69  * Net information.
70  */
71 typedef struct coap_context_t coap_context_t;
72 typedef struct coap_queue_t coap_queue_t;
73 
74 /* ************* coap_pdu_internal.h ***************** */
75 
79 typedef struct coap_pdu_t coap_pdu_t;
80 
81 /* ************* coap_resource_internal.h ***************** */
82 
83 /*
84  * Resource information.
85  */
86 typedef struct coap_attr_t coap_attr_t;
87 typedef struct coap_resource_t coap_resource_t;
88 
89 /* ************* coap_session_internal.h ***************** */
90 
91 /*
92  * Session information.
93  */
94 typedef struct coap_addr_hash_t coap_addr_hash_t;
95 typedef struct coap_endpoint_t coap_endpoint_t;
96 typedef struct coap_session_t coap_session_t;
97 
98 /* ************* coap_subscribe_internal.h ***************** */
99 
100 /*
101  * Observe subscriber information.
102  */
104 
105 #endif /* COAP_FORWARD_DECLS_H_ */
Only used for servers for hashing incoming packets.
multi-purpose address abstraction
Definition: address.h:94
Abstraction of attribute associated with a resource.
CoAP binary data definition with const data.
Definition: str.h:56
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:242
Abstraction of virtual endpoint that can be attached to coap_context_t.
Structure to hold large body (many blocks) client receive information.
Structure to hold large body (many blocks) server receive information.
Structure to hold large body (many blocks) transmission information.
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
Queue entry.
Abstraction of resource that can be attached to coap_context_t.
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
CoAP string data definition with const data.
Definition: str.h:38
CoAP string data definition.
Definition: str.h:30
Subscriber information.