libcoap 4.3.0
coap_session.h
Go to the documentation of this file.
1/* coap_session.h -- Session management for libcoap
2*
3* Copyright (C) 2017 Jean-Claue Michelou <jcm@spinetix.com>
4*
5 * SPDX-License-Identifier: BSD-2-Clause
6 *
7* This file is part of the CoAP library libcoap. Please see
8* README for terms of use.
9*/
10
16#ifndef COAP_SESSION_H_
17#define COAP_SESSION_H_
18
29typedef struct coap_fixed_point_t {
30 uint16_t integer_part;
31 uint16_t fractional_part;
34
35#define COAP_PROTO_NOT_RELIABLE(p) ((p)==COAP_PROTO_UDP || (p)==COAP_PROTO_DTLS)
36#define COAP_PROTO_RELIABLE(p) ((p)==COAP_PROTO_TCP || (p)==COAP_PROTO_TLS)
37
41typedef enum coap_session_type_t {
48
59
67
76
85 coap_nack_reason_t reason);
86
94void coap_session_set_app_data(coap_session_t *session, void *data);
95
105void *coap_session_get_app_data(const coap_session_t *session);
106
115 const coap_session_t *session);
116
125 const coap_session_t *session);
126
135
144
153
161int coap_session_get_ifindex(const coap_session_t *session);
162
176void *coap_session_get_tls(const coap_session_t *session,
177 coap_tls_library_t *tls_lib);
178
187
200
208void coap_session_set_mtu(coap_session_t *session, unsigned mtu);
209
216size_t coap_session_max_pdu_size(const coap_session_t *session);
217
228 coap_context_t *ctx,
229 const coap_address_t *local_if,
230 const coap_address_t *server,
231 coap_proto_t proto
232);
233
247 coap_context_t *ctx,
248 const coap_address_t *local_if,
249 const coap_address_t *server,
250 coap_proto_t proto,
251 const char *identity,
252 const uint8_t *key,
253 unsigned key_len
254);
255
272 coap_context_t *ctx,
273 const coap_address_t *local_if,
274 const coap_address_t *server,
275 coap_proto_t proto,
276 coap_dtls_cpsk_t *setup_data
277);
278
287 const coap_session_t *session);
288
297 const coap_session_t *session);
298
315 coap_context_t *ctx,
316 const coap_address_t *local_if,
317 const coap_address_t *server,
318 coap_proto_t proto,
319 coap_dtls_pki_t *setup_data
320);
321
330void coap_session_init_token(coap_session_t *session, size_t length,
331 const uint8_t *token);
332
341void coap_session_new_token(coap_session_t *session, size_t *length,
342 uint8_t *token);
343
351const char *coap_session_str(const coap_session_t *session);
352
362
370void coap_endpoint_set_default_mtu(coap_endpoint_t *endpoint, unsigned mtu);
371
373
383const char *coap_endpoint_str(const coap_endpoint_t *endpoint);
384
386 const coap_address_t *remote_addr, int ifindex);
387
403#define COAP_DEFAULT_ACK_TIMEOUT ((coap_fixed_point_t){2,0})
404
412#define COAP_DEFAULT_ACK_RANDOM_FACTOR ((coap_fixed_point_t){1,500})
413
420#define COAP_DEFAULT_MAX_RETRANSMIT 4
421
427#define COAP_DEFAULT_NSTART 1
428
434#ifndef COAP_DEFAULT_LEISURE
435#define COAP_DEFAULT_LEISURE (5U)
436#endif /* COAP_DEFAULT_LEISURE */
437
444#define COAP_MAX_TRANSMIT_SPAN(s) \
445 ((s->ack_timeout.integer_part * 1000 + s->ack_timeout.fractional_part) * \
446 ((1 << (s->max_retransmit)) -1) * \
447 (s->ack_random_factor.integer_part * 1000 + \
448 s->ack_random_factor.fractional_part) \
449 / 1000000)
450
457#define COAP_MAX_TRANSMIT_WAIT(s) \
458 ((s->ack_timeout.integer_part * 1000 + s->ack_timeout.fractional_part) * \
459 ((1 << (s->max_retransmit + 1)) -1) * \
460 (s->ack_random_factor.integer_part * 1000 + \
461 s->ack_random_factor.fractional_part) \
462 / 1000000)
463
468#define COAP_MAX_LATENCY 100
469
476#define COAP_PROCESSING_DELAY(s) \
477 ((s->ack_timeout.integer_part * 1000 + s->ack_timeout.fractional_part + 500) \
478 / 1000)
479
486#define COAP_MAX_RTT(s) \
487 ((2 * COAP_MAX_LATENCY) + COAP_PROCESSING_DELAY(s))
488
495#define COAP_EXCHANGE_LIFETIME(s) \
496 (COAP_MAX_TRANSMIT_SPAN(s) + (2 * COAP_MAX_LATENCY) + COAP_PROCESSING_DELAY(s))
497
504#define COAP_NON_LIFETIME(s) \
505 (COAP_MAX_TRANSMIT_SPAN(s) + COAP_MAX_LATENCY)
506
519 unsigned int value);
520
532 coap_fixed_point_t value);
533
545 coap_fixed_point_t value);
546
556unsigned int coap_session_get_max_retransmit(const coap_session_t *session);
557
569
581 const coap_session_t *session);
582
590
591#endif /* COAP_SESSION_H */
coap_nack_reason_t
Definition: coap_io.h:64
void coap_session_set_max_retransmit(coap_session_t *session, unsigned int value)
Set the CoAP maximum retransmit count before failure.
Definition: coap_session.c:25
coap_mid_t coap_session_send_ping(coap_session_t *session)
Send a ping message for the session.
Definition: coap_session.c:381
void coap_session_set_ack_random_factor(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP ack randomize factor.
Definition: coap_session.c:44
coap_fixed_point_t coap_session_get_ack_random_factor(const coap_session_t *session)
Get the CoAP ack randomize factor.
Definition: coap_session.c:65
void coap_session_set_ack_timeout(coap_session_t *session, coap_fixed_point_t value)
Set the CoAP initial ack response timeout before the next re-transmit.
Definition: coap_session.c:34
coap_session_t * coap_session_get_by_peer(const coap_context_t *ctx, const coap_address_t *remote_addr, int ifindex)
coap_fixed_point_t coap_session_get_ack_timeout(const coap_session_t *session)
Get the CoAP initial ack response timeout before the next re-transmit.
Definition: coap_session.c:60
unsigned int coap_session_get_max_retransmit(const coap_session_t *session)
Get the CoAP maximum retransmit before failure.
Definition: coap_session.c:55
coap_tls_library_t
Definition: coap_dtls.h:52
const char * coap_endpoint_str(const coap_endpoint_t *endpoint)
Get endpoint description.
const char * coap_session_str(const coap_session_t *session)
Get session description.
int coap_mid_t
coap_mid_t is used to store the CoAP Message ID of a CoAP PDU.
Definition: pdu.h:231
coap_proto_t
CoAP protocol types.
Definition: pdu.h:280
coap_session_type_t
coap_session_type_t values
Definition: coap_session.h:41
void coap_free_endpoint(coap_endpoint_t *ep)
void coap_session_set_mtu(coap_session_t *session, unsigned mtu)
Set the session MTU.
Definition: coap_session.c:265
coap_context_t * coap_session_get_context(const coap_session_t *session)
Get the session context.
const coap_address_t * coap_session_get_addr_local(const coap_session_t *session)
Get the local IP address from the session.
coap_proto_t coap_session_get_proto(const coap_session_t *session)
Get the session protocol type.
size_t coap_session_max_pdu_size(const coap_session_t *session)
Get maximum acceptable PDU size.
Definition: coap_session.c:244
const coap_bin_const_t * coap_session_get_psk_key(const coap_session_t *session)
Get the session's current pre-shared key (PSK).
void * coap_session_get_tls(const coap_session_t *session, coap_tls_library_t *tls_lib)
Get the session TLS security ptr (TLS type dependent)
coap_session_state_t coap_session_get_state(const coap_session_t *session)
Get the session state.
coap_session_state_t
coap_session_state_t values
Definition: coap_session.h:52
coap_session_t * coap_new_client_session_pki(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_pki_t *setup_data)
Creates a new client session to the designated server with PKI credentials.
coap_endpoint_t * coap_new_endpoint(coap_context_t *context, const coap_address_t *listen_addr, coap_proto_t proto)
Create a new endpoint for communicating with peers.
void coap_session_init_token(coap_session_t *session, size_t length, const uint8_t *token)
Initializes the token value to use as a starting point.
coap_session_t * coap_new_client_session_psk(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, const char *identity, const uint8_t *key, unsigned key_len)
Creates a new client session to the designated server with PSK credentials.
Definition: coap_session.c:913
void coap_session_new_token(coap_session_t *session, size_t *length, uint8_t *token)
Creates a new token for use.
void coap_session_set_app_data(coap_session_t *session, void *data)
Stores data with the given session.
Definition: coap_session.c:98
void coap_session_release(coap_session_t *session)
Decrement reference counter on a session.
Definition: coap_session.c:76
void coap_endpoint_set_default_mtu(coap_endpoint_t *endpoint, unsigned mtu)
Set the endpoint's default MTU.
const coap_bin_const_t * coap_session_get_psk_hint(const coap_session_t *session)
Get the server session's current Identity Hint (PSK).
const coap_address_t * coap_session_get_addr_remote(const coap_session_t *session)
Get the remote IP address from the session.
coap_session_t * coap_new_client_session(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto)
Creates a new client session to the designated server.
Definition: coap_session.c:898
int coap_session_set_type_client(coap_session_t *session)
Set the session type to client.
coap_session_t * coap_new_client_session_psk2(coap_context_t *ctx, const coap_address_t *local_if, const coap_address_t *server, coap_proto_t proto, coap_dtls_cpsk_t *setup_data)
Creates a new client session to the designated server with PSK credentials.
Definition: coap_session.c:940
void coap_session_disconnected(coap_session_t *session, coap_nack_reason_t reason)
Notify session that it has failed.
Definition: coap_session.c:456
struct coap_fixed_point_t coap_fixed_point_t
Abstraction of a fixed point number that can be used where necessary instead of a float.
coap_session_t * coap_session_reference(coap_session_t *session)
Increment reference counter on a session.
Definition: coap_session.c:70
int coap_session_get_ifindex(const coap_session_t *session)
Get the session if index.
void * coap_session_get_app_data(const coap_session_t *session)
Returns any application-specific data that has been stored with session using the function coap_sessi...
Definition: coap_session.c:104
coap_session_type_t coap_session_get_type(const coap_session_t *session)
Get the session type.
@ COAP_SESSION_TYPE_NONE
Not defined.
Definition: coap_session.h:42
@ COAP_SESSION_TYPE_HELLO
server-side ephemeral session for responding to a client hello
Definition: coap_session.h:45
@ COAP_SESSION_TYPE_SERVER
server-side
Definition: coap_session.h:44
@ COAP_SESSION_TYPE_CLIENT
client-side
Definition: coap_session.h:43
@ COAP_SESSION_STATE_HANDSHAKE
Definition: coap_session.h:55
@ COAP_SESSION_STATE_CSM
Definition: coap_session.h:56
@ COAP_SESSION_STATE_ESTABLISHED
Definition: coap_session.h:57
@ COAP_SESSION_STATE_NONE
Definition: coap_session.h:53
@ COAP_SESSION_STATE_CONNECTING
Definition: coap_session.h:54
multi-purpose address abstraction
Definition: address.h:96
CoAP binary data definition with const data.
Definition: str.h:58
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:338
The structure used for defining the PKI setup data to be used.
Definition: coap_dtls.h:244
Abstraction of virtual endpoint that can be attached to coap_context_t.
Abstraction of a fixed point number that can be used where necessary instead of a float.
Definition: coap_session.h:29
uint16_t fractional_part
Fractional part of fixed point variable 1/1000 (3 points) precision.
Definition: coap_session.h:31
uint16_t integer_part
Integer part of fixed point variable.
Definition: coap_session.h:30
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...