libcoap 4.3.1rc1
coap_subscribe_internal.h
Go to the documentation of this file.
1/*
2 * coap_subscribe_internal.h -- Structures, Enums & Functions that are not
3 * exposed to application programming
4 *
5 * Copyright (C) 2010-2021 Olaf Bergmann <bergmann@tzi.org>
6 *
7 * SPDX-License-Identifier: BSD-2-Clause
8 *
9 * This file is part of the CoAP library libcoap. Please see README for terms
10 * of use.
11 */
12
18#ifndef COAP_SUBSCRIBE_INTERNAL_H_
19#define COAP_SUBSCRIBE_INTERNAL_H_
20
21#include "coap_internal.h"
22
23#if COAP_SERVER_SUPPORT
24
32#ifndef COAP_OBS_MAX_NON
38#define COAP_OBS_MAX_NON 5
39#endif /* COAP_OBS_MAX_NON */
40
41#ifndef COAP_OBS_MAX_FAIL
47#define COAP_OBS_MAX_FAIL 3
48#endif /* COAP_OBS_MAX_FAIL */
49
55 unsigned int non_cnt:4;
56 unsigned int fail_cnt:2;
57 unsigned int dirty:1;
62};
63
65
73void
75 coap_session_t *session,
76 const coap_binary_t *token);
77
85
101 coap_session_t *session,
102 const coap_binary_t *token,
103 const coap_pdu_t *pdu);
104
115 coap_session_t *session,
116 const coap_binary_t *token);
117
127 coap_session_t *session,
128 const coap_binary_t *token);
129
142 coap_session_t *session,
143 const coap_binary_t *token);
144
152
155#endif /* COAP_SERVER_SUPPORT */
156#endif /* COAP_SUBSCRIBE_INTERNAL_H_ */
Pulls together all the internal only header files.
int coap_delete_observer(coap_resource_t *resource, coap_session_t *session, const coap_binary_t *token)
Removes any subscription for observer from resource and releases the allocated storage.
coap_subscription_t * coap_add_observer(coap_resource_t *resource, coap_session_t *session, const coap_binary_t *token, const coap_pdu_t *pdu)
Adds the specified peer as observer for resource.
void coap_delete_observers(coap_context_t *context, coap_session_t *session)
Removes any subscription for session and releases the allocated storage.
void coap_check_notify(coap_context_t *context)
Checks all known resources to see if they are dirty and then notifies subscribed observers.
void coap_handle_failed_notify(coap_context_t *context, coap_session_t *session, const coap_binary_t *token)
Handles a failed observe notify.
void coap_subscription_init(coap_subscription_t *)
void coap_touch_observer(coap_context_t *context, coap_session_t *session, const coap_binary_t *token)
Flags that data is ready to be sent to observers.
coap_subscription_t * coap_find_observer(coap_resource_t *resource, coap_session_t *session, const coap_binary_t *token)
Returns a subscription object for given peer.
CoAP binary data definition.
Definition: str.h:56
The CoAP stack's global state is stored in a coap_context_t object.
structure for CoAP PDUs token, if any, follows the fixed size header, then options until payload mark...
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_context_t * context
session's context
Subscriber information.
unsigned int fail_cnt
up to 3 confirmable notifies can fail
unsigned int non_cnt
up to 15 non-confirmable notifies allowed
coap_cache_key_t * cache_key
struct coap_session_t * session
subscriber session
unsigned int dirty
set if the notification temporarily could not be sent (in that case, the resource's partially dirty f...
struct coap_subscription_t * next
next element in linked list
coap_pdu_t * pdu
cache_key to identify requester