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 ClientCB {
46 // callback method defined in application address space
47 OCClientResponseHandler callBack;
48 // callback context data
50 // callback method to delete context data
51 OCClientContextDeleter deleteCallback;
52 // when a response is recvd with this token, above callback will be invoked
54 // Invocation handle tied to original call to OCDoResource()
56 // This is used to determine if all responses should be consumed or not.
57 // (For now, only pertains to OC_REST_OBSERVE_ALL Vs. OC_REST_OBSERVE functionality)
59 // This is the sequence identifier the server applies to the invocation tied to 'handle'.
60 uint32_t sequenceNumber;
61 // This is the request uri associated with the call back
63 // Struct to hold TTL info for presence
65 OCPresence * presence;
66 OCResourceType * filterResourceType;
68 // next node in this list
69 struct ClientCB *next;
72 extern struct ClientCB *cbList;
76 * This method is used to add a client callback method in cbList.
78 * @param[out] clientCB
79 * The resulting node from making this call. Null if out of memory.
81 * address to client callback function.
83 * identifier for OTA CoAP comms.
85 * Masked in the public API as an 'invocation handle' - Used for callback management.
87 * OCMethod via which this client callback is expected to operate
88 * @param[in] requestUri
89 * the resource uri of the request.
90 * @param[in] resourceType
91 * the resourceType associated with a presence request.
93 * @brief If the handle you're looking for does not exist, the stack will reply with a RST message.
95 * @return OC_STACK_OK for Success, otherwise some error value
98 AddClientCB (ClientCB** clientCB, OCCallbackData* cbData,
99 CAToken_t * token, OCDoHandle *handle, OCMethod method,
100 char * requestUri, char * resourceTypeName);
104 * This method is used to remove a callback node from cbList.
107 * address to client callback node.
109 void DeleteClientCB(ClientCB *cbNode);
114 * This method is used to search and retrieve a cb node in cbList.
117 * token to search for.
119 * handle to search for.
120 * @param[in] requestUri
123 * @brief You can search by token OR by handle, but not both.
125 * @return address of the node if found, otherwise NULL
127 ClientCB* GetClientCB(const CAToken_t * token, OCDoHandle handle, const char * requestUri);
130 * Inserts a new resource type filter into this cb node.
133 * the node to add the new resourceType filter to
134 * @param[in] resourceTypeName
135 * the value to create the new resourceType filter from
138 * OC_STACK_OK on success
139 * OC_STACK_ERROR with invalid parameters
140 * OC_STACK_NO_MEMORY when out of memory
143 OCStackResult InsertResourceTypeFilter(ClientCB * cbNode, const char * resourceTypeName);
144 #endif // WITH_PRESENCE
148 * This method is used to clear the cbList.
151 void DeleteClientCBList();
155 * This method is used to verify the presence of a cb node in cbList
156 * and then delete it.
159 * address to client callback node.
161 void FindAndDeleteClientCB(ClientCB * cbNode);
165 * This method is used to search a multicast presence node from list.
168 * the uri of the request.
170 * @return OCMulticastNode
171 * The resulting node from making this call. Null if doesn't exist.
173 //------------------------------------------------------------------------
174 OCMulticastNode* GetMCPresenceNode(const char * uri);
178 * This method is used to add a multicast presence node to the list.
180 * @param[out] outnode
181 * The resulting node from making this call. Null if out of memory.
183 * the uri of the server.
185 * current nonce for the server
187 * @return OC_STACK_OK for Success, otherwise some error value
189 //------------------------------------------------------------------------
190 OCStackResult AddMCPresenceNode(OCMulticastNode** outnode, char* uri, uint32_t nonce);
192 #endif //OC_CLIENT_CB