libcoap  4.3.0rc2
coap_session_internal.h
Go to the documentation of this file.
1 /*
2  * coap_session_internal.h -- Structures, Enums & Functions that are not
3  * exposed to application programming
4  *
5  * Copyright (C) 2010-2019 Olaf Bergmann <bergmann@tzi.org>
6  *
7  * This file is part of the CoAP library libcoap. Please see README for terms
8  * of use.
9  */
10 
16 #ifndef COAP_SESSION_INTERNAL_H_
17 #define COAP_SESSION_INTERNAL_H_
18 
19 #include "coap_io_internal.h"
20 
21 #define COAP_DEFAULT_SESSION_TIMEOUT 300
22 #define COAP_PARTIAL_SESSION_TIMEOUT_TICKS (30 * COAP_TICKS_PER_SECOND)
23 #define COAP_DEFAULT_MAX_HANDSHAKE_SESSIONS 100
24 
38  uint16_t lport;
40 };
41 
46 struct coap_session_t {
51  unsigned ref;
52  size_t tls_overhead;
53  size_t mtu;
57  int ifindex;
62  void *tls;
63  uint16_t tx_mid;
65  uint8_t con_active;
74  size_t partial_write;
77  uint8_t read_header[8];
79  size_t partial_read;
116  void *app;
117  unsigned int max_retransmit;
123  unsigned int dtls_timeout_count;
126  uint8_t block_mode;
127  uint64_t tx_token;
128 };
129 
138  uint16_t default_mtu;
143 };
144 
151 
158 
170  const coap_bin_const_t *psk_hint);
171 
183  const coap_bin_const_t *psk_key);
184 
194  coap_context_t *ctx,
195  coap_endpoint_t *ep
196 );
197 
210 ssize_t coap_session_send(coap_session_t *session,
211  const uint8_t *data, size_t datalen);
212 
226 ssize_t coap_session_write(coap_session_t *session,
227  const uint8_t *data, size_t datalen);
228 
240 ssize_t coap_session_send_pdu(coap_session_t *session, coap_pdu_t *pdu);
241 
242 ssize_t
244  coap_queue_t *node);
245 
256  const coap_packet_t *packet, coap_tick_t now);
257 
270  coap_tick_t now);
271 
272 void coap_session_free(coap_session_t *session);
273 void coap_session_mfree(coap_session_t *session);
274 
277 #define SESSIONS_ADD(e, obj) \
278  HASH_ADD(hh, (e), addr_hash, sizeof((obj)->addr_hash), (obj))
279 
280 #define SESSIONS_DELETE(e, obj) \
281  HASH_DELETE(hh, (e), (obj))
282 
283 #define SESSIONS_ITER(e, el, rtmp) \
284  HASH_ITER(hh, (e), el, rtmp)
285 
286 #define SESSIONS_ITER_SAFE(e, el, rtmp) \
287 for ((el) = (e); (el) && ((rtmp) = (el)->hh.next, 1); (el) = (rtmp))
288 
289 #define SESSIONS_FIND(e, k, res) { \
290  HASH_FIND(hh, (e), &(k), sizeof(k), (res)); \
291  }
292 
293 #endif /* COAP_SESSION_INTERNAL_H_ */
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition: coap_time.h:120
coap_session_t * coap_session_new_dtls_session(coap_session_t *session, coap_tick_t now)
Create a new DTLS session for the session.
Definition: coap_session.c:692
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: pdu.h:229
coap_proto_t
CoAP protocol types.
Definition: pdu.h:278
coap_session_t * coap_endpoint_get_session(coap_endpoint_t *endpoint, const coap_packet_t *packet, coap_tick_t now)
Lookup the server session for the packet received on an endpoint, or create a new one.
Definition: coap_session.c:555
ssize_t coap_session_delay_pdu(coap_session_t *session, coap_pdu_t *pdu, coap_queue_t *node)
Definition: coap_session.c:310
int coap_session_refresh_psk_hint(coap_session_t *session, const coap_bin_const_t *psk_hint)
Refresh the session's current Identity Hint (PSK).
Definition: coap_session.c:997
void coap_session_send_csm(coap_session_t *session)
Notify session transport has just connected and CSM exchange can now start.
Definition: coap_session.c:349
coap_session_t * coap_new_server_session(coap_context_t *ctx, coap_endpoint_t *ep)
Creates a new server session for the specified endpoint.
ssize_t coap_session_send(coap_session_t *session, const uint8_t *data, size_t datalen)
Function interface for datagram data transmission.
Definition: coap_session.c:275
int coap_session_refresh_psk_key(coap_session_t *session, const coap_bin_const_t *psk_key)
Refresh the session's current pre-shared key (PSK).
void coap_session_connected(coap_session_t *session)
Notify session that it has just connected or reconnected.
Definition: coap_session.c:397
ssize_t coap_session_send_pdu(coap_session_t *session, coap_pdu_t *pdu)
Send a pdu according to the session's protocol.
Definition: net.c:764
void coap_session_free(coap_session_t *session)
Definition: coap_session.c:223
void coap_session_mfree(coap_session_t *session)
Definition: coap_session.c:157
ssize_t coap_session_write(coap_session_t *session, const uint8_t *data, size_t datalen)
Function interface for stream data transmission.
Definition: coap_session.c:296
coap_session_type_t
coap_session_type_t values
Definition: coap_session.h:39
coap_session_state_t
coap_session_state_t values
Definition: coap_session.h:50
Only used for servers for hashing incoming packets.
uint16_t lport
local port
coap_address_t remote
remote address and port
coap_proto_t proto
CoAP protocol.
multi-purpose address abstraction
Definition: address.h:94
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 Client PSK setup data to be used.
Definition: coap_dtls.h:334
Abstraction of virtual endpoint that can be attached to coap_context_t.
coap_context_t * context
endpoint's context
uint16_t default_mtu
default mtu for this interface
coap_session_t * sessions
hash table or list of active sessions
struct coap_endpoint_t * next
coap_address_t bind_addr
local interface address
coap_socket_t sock
socket object for the interface, if any
coap_proto_t proto
protocol used on this interface
Abstraction of a fixed point number that can be used where necessary instead of a float.
Definition: coap_session.h:27
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 virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
coap_lg_xmit_t * lg_xmit
list of large transmissions
unsigned int dtls_timeout_count
dtls setup retry counter
coap_bin_const_t * psk_key
If client, this field contains the current pre-shared key for server; When this field is NULL,...
coap_endpoint_t * endpoint
session's endpoint
coap_socket_t sock
socket object for the session, if any
unsigned int max_retransmit
maximum re-transmit count (default 4)
coap_pdu_t * partial_pdu
incomplete incoming pdu
coap_bin_const_t * psk_identity
If client, this field contains the current identity for server; When this field is NULL,...
coap_session_state_t state
current state of relationaship with peer
uint64_t tx_token
Next token number to use.
uint8_t block_mode
Zero or more COAP_BLOCK_ or'd options.
uint8_t read_header[8]
storage space for header of incoming message header
coap_addr_tuple_t addr_info
key: remote/local address info
coap_proto_t proto
protocol used
uint16_t tx_mid
the last message id that was used in this session
unsigned ref
reference count from queues
coap_bin_const_t * psk_hint
If client, this field contains the server provided identity hint.
coap_dtls_cpsk_t cpsk_setup_data
client provided PSK initial setup data
size_t mtu
path or CSM mtu
size_t partial_read
if > 0 indicates number of bytes already read for an incoming message
int dtls_event
Tracking any (D)TLS events on this sesison.
void * tls
security parameters
uint8_t csm_block_supported
CSM TCP blocks supported.
coap_fixed_point_t ack_random_factor
ack random factor backoff (default 1.5)
uint8_t con_active
Active CON request sent.
coap_queue_t * delayqueue
list of delayed messages waiting to be sent
size_t tls_overhead
overhead of TLS layer
void * app
application-specific data
coap_mid_t last_ping_mid
the last keepalive message id that was used in this session
coap_lg_srcv_t * lg_srcv
Server list of expected large receives.
coap_lg_crcv_t * lg_crcv
Client list of expected large receives.
coap_fixed_point_t ack_timeout
timeout waiting for ack (default 2 secs)
coap_session_type_t type
client or server side socket
coap_context_t * context
session's context
size_t partial_write
if > 0 indicates number of bytes already written from the pdu at the head of sendqueue
coap_addr_hash_t addr_hash
Address hash for server incoming packets.
int ifindex
interface index