1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
27 #include "ocresource.h"
30 typedef struct OCPresence
32 // This is the TTL associated with presence
38 typedef struct OCMulticastNode
42 struct OCMulticastNode * next;
45 typedef struct resourcetype_t OCResourceType;
47 typedef struct ClientCB {
48 // callback method defined in application address space
49 OCClientResponseHandler callBack;
50 // callback context data
52 // callback method to delete context data
53 OCClientContextDeleter deleteCallback;
54 // when a response is recvd with this token, above callback will be invoked
56 // a response is recvd with this token length
58 // Invocation handle tied to original call to OCDoResource()
60 // This is used to determine if all responses should be consumed or not.
61 // (For now, only pertains to OC_REST_OBSERVE_ALL Vs. OC_REST_OBSERVE functionality)
63 // This is the sequence identifier the server applies to the invocation tied to 'handle'.
64 uint32_t sequenceNumber;
65 // This is the request uri associated with the call back
67 // Struct to hold TTL info for presence
69 OCPresence * presence;
70 OCResourceType * filterResourceType;
72 // The connectivity type on which the request was sent on.
73 OCConnectivityType conType;
74 // The TTL for this callback. Holds the time till when this callback can
75 // still be used. TTL is set to 0 when the callback is for presence and observe.
76 // Presence has ttl mechanism in the "presence" member of this struct and observes
77 // can be explicitly cancelled.
79 // next node in this list
80 struct ClientCB *next;
83 extern struct ClientCB *cbList;
87 * This method is used to add a client callback method in cbList.
89 * @param[out] clientCB
90 * The resulting node from making this call. Null if out of memory.
92 * address to client callback function.
94 * identifier for OTA CoAP comms.
96 * Masked in the public API as an 'invocation handle' - Used for callback management.
98 * OCMethod via which this client callback is expected to operate
99 * @param[in] requestUri
100 * the resource uri of the request.
101 * @param[in] resourceType
102 * the resourceType associated with a presence request.
104 * the connectivity type on which the associated request for this clientCB was sent on.
106 * time to live in coap_ticks for the callback.
107 * @brief If the handle you're looking for does not exist, the stack will reply with a RST message.
109 * @return OC_STACK_OK for Success, otherwise some error value
112 AddClientCB (ClientCB** clientCB, OCCallbackData* cbData,
113 CAToken_t token, uint8_t tokenLength,
114 OCDoHandle *handle, OCMethod method,
115 char * requestUri, char * resourceTypeName, OCConnectivityType conType, uint32_t ttl);
119 * This method is used to remove a callback node from cbList.
122 * address to client callback node.
124 void DeleteClientCB(ClientCB *cbNode);
129 * This method is used to search and retrieve a cb node in cbList.
132 * token to search for.
134 * handle to search for.
135 * @param[in] requestUri
138 * @brief You can search by token OR by handle, but not both.
140 * @return address of the node if found, otherwise NULL
142 ClientCB* GetClientCB(const CAToken_t token, uint8_t tokenLength,
143 OCDoHandle handle, const char * requestUri);
146 * Inserts a new resource type filter into this cb node.
149 * the node to add the new resourceType filter to
150 * @param[in] resourceTypeName
151 * the value to create the new resourceType filter from
154 * OC_STACK_OK on success
155 * OC_STACK_ERROR with invalid parameters
156 * OC_STACK_NO_MEMORY when out of memory
159 OCStackResult InsertResourceTypeFilter(ClientCB * cbNode, char * resourceTypeName);
160 #endif // WITH_PRESENCE
164 * This method is used to clear the cbList.
167 void DeleteClientCBList();
171 * This method is used to verify the presence of a cb node in cbList
172 * and then delete it.
175 * address to client callback node.
177 void FindAndDeleteClientCB(ClientCB * cbNode);
181 * This method is used to search a multicast presence node from list.
184 * the uri of the request.
186 * @return OCMulticastNode
187 * The resulting node from making this call. Null if doesn't exist.
189 //------------------------------------------------------------------------
190 OCMulticastNode* GetMCPresenceNode(const char * uri);
194 * This method is used to add a multicast presence node to the list.
196 * @param[out] outnode
197 * The resulting node from making this call. Null if out of memory.
199 * the uri of the server.
201 * current nonce for the server
203 * @return OC_STACK_OK for Success, otherwise some error value
205 //------------------------------------------------------------------------
206 OCStackResult AddMCPresenceNode(OCMulticastNode** outnode, char* uri, uint32_t nonce);
208 #endif //OC_CLIENT_CB