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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
22 //-----------------------------------------------------------------------------
23 // Internal include file used by lower layers of the OC stack
24 //-----------------------------------------------------------------------------
25 #ifndef OCSTACKINTERNAL_H_
26 #define OCSTACKINTERNAL_H_
28 //-----------------------------------------------------------------------------
30 //-----------------------------------------------------------------------------
33 #include "ocstackconfig.h"
34 #include "occlientcb.h"
39 #include "cainterface.h"
46 //-----------------------------------------------------------------------------
48 //-----------------------------------------------------------------------------
49 extern OCDeviceEntityHandler defaultDeviceHandler;
50 extern void* defaultDeviceHandlerCallbackParameter;
52 //-----------------------------------------------------------------------------
54 //-----------------------------------------------------------------------------
55 #define OC_COAP_SCHEME "coap://"
56 #define OC_OFFSET_SEQUENCE_NUMBER (4) // the first outgoing sequence number will be 5
59 * This structure will be created in occoap and passed up the stack on the server side.
63 // Observe option field
64 uint32_t observationOption;
65 // the REST method retrieved from received request PDU
67 // resourceUrl will be filled in occoap using the path options in received request PDU
68 char resourceUrl[MAX_URI_LENGTH];
69 // resource query send by client
70 char query[MAX_QUERY_LENGTH];
71 // reqJSON is retrieved from the payload of the received request PDU
72 char reqJSONPayload[MAX_REQUEST_LENGTH];
73 // qos is indicating if the request is CON or NON
74 OCQualityOfService qos;
75 // An array of the received vendor specific header options
76 uint8_t numRcvdVendorSpecificHeaderOptions;
77 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
79 /** Remote endpoint address **/
82 //token for the observe request
83 CAToken_t requestToken;
84 uint8_t tokenLength; //token length
87 uint8_t delayedResNeeded;
88 uint8_t reqMorePacket;
89 uint32_t reqPacketNum;
90 uint16_t reqPacketSize;
91 uint32_t resPacketNum;
92 uint16_t resPacketSize;
94 } OCServerProtocolRequest;
97 * This structure will be created in occoap and passed up the stack on the client side.
101 // handle is retrieved by comparing the token-handle pair in the PDU.
103 // This is how long this response is valid for (in seconds).
105 // This is the Uri of the resource. (ex. "coap://192.168.1.1/a/led")
107 // This is the relative Uri of the resource. (ex. "/a/led")
109 // This is the received payload.
112 // This is the token received OTA.
115 // this structure will be passed to client
116 OCClientResponse * clientResponse;
120 * This typedef is to represent our Server Instance identification.
122 typedef uint8_t ServerID[16];
124 //-----------------------------------------------------------------------------
125 // Internal function prototypes
126 //-----------------------------------------------------------------------------
129 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status);
131 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest);
133 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
134 const CAResponseResult_t responseResult, const CAMessageType_t type,
135 const uint8_t numOptions, const CAHeaderOption_t *options,
136 CAToken_t token, uint8_t tokenLength);
140 * The OCPresenceTrigger enum delineates the three spec-compliant modes for
141 * "Trigger." These enum values are then mapped to JSON strings
142 * "create", "change", "delete", respectively, before getting encoded into
145 * @enum OC_PRESENCE_TRIGGER_CREATE The creation of a resource is associated with
146 * this invocation of @ref SendPresenceNotification.
147 * @enum OC_PRESENCE_TRIGGER_CHANGE The change/update of a resource is associated
148 * this invocation of @ref SendPresenceNotification.
149 * @enum OC_PRESENCE_TRIGGER_DELETE The deletion of a resource is associated with
150 * this invocation of @ref SendPresenceNotification.
155 OC_PRESENCE_TRIGGER_CREATE = 0,
156 OC_PRESENCE_TRIGGER_CHANGE = 1,
157 OC_PRESENCE_TRIGGER_DELETE = 2
161 * Notify Presence subscribers that a resource has been modified.
163 * @param resourceType Handle to the resourceType linked list of resource
165 * @param trigger The simplified reason this API was invoked. Valid values are
166 * @ref OC_PRESENCE_TRIGGER_CREATE, @ref OC_PRESENCE_TRIGGER_CHANGE,
167 * @ref OC_PRESENCE_TRIGGER_DELETE.
168 * @return ::OC_STACK_OK on success, some other value upon failure.
170 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
171 OCPresenceTrigger trigger);
174 * Send Stop Notification to Presence subscribers.
176 * @return ::OC_STACK_OK on success, some other value upon failure.
178 OCStackResult SendStopNotification();
179 #endif // WITH_PRESENCE
180 bool ParseIPv4Address(char * ipAddrStr, uint8_t * ipAddr, uint16_t * port);
183 * Bind a resource interface to a resource.
185 * @param resource Target resource.
186 * @param resourceInterfaceName Resource interface.
187 * @return ::OC_STACK_OK on success, some other value upon failure.
189 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
190 const char *resourceInterfaceName);
192 * Bind a resourcetype to a resource.
194 * @param resource Target resource.
195 * @param resourceTypeName Name of resource type.
196 * @return ::OC_STACK_OK on success, some other value upon failure.
198 OCStackResult BindResourceTypeToResource(OCResource* resource,
199 const char *resourceTypeName);
201 // Converts a CAResult_t type to a OCStackResult type.
203 * Converts a CAResult_t type to a OCStackResult type.
205 * @param caResult CAResult_t value to convert
206 * @return OCStackResult that was converted from the input CAResult_t value.
208 OCStackResult CAResultToOCResult(CAResult_t caResult);
211 * Get a byte representation of the server instance ID.
212 * The memory is managed internal to this function, so freeing it externally will
213 * result in a runtime error
215 * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
216 * This is done automatically during the OCInit process,
217 * so ensure that this call is done after that.
219 * @return A uint8_t representation the server instance ID.
221 const uint8_t* OCGetServerInstanceID(void);
224 * Get a string representation the server instance ID.
225 * The memory is managed internal to this function, so freeing externally will result
227 * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
228 * This is done automatically during the OCInit process,
229 * so ensure that this call is done after that.
231 * @return A string representation the server instance ID.
233 const char* OCGetServerInstanceIDString(void);
236 * Map OCQualityOfService to CAMessageType.
238 * @param qos Input qos.
239 * @return CA message type for a given qos.
241 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos);
245 * Enable/disable a resource property.
247 * @param inputProperty Pointer to resource property.
248 * @param resourceProperties Property to be enabled/disabled.
249 * @param enable 0:disable, 1:enable.
251 * @return OCStackResult that was converted from the input CAResult_t value.
253 //TODO: should the following function be public?
254 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
255 OCResourceProperty resourceProperties, uint8_t enable);
258 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
260 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
262 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out);
264 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out);
268 #endif // __cplusplus
270 #endif /* OCSTACKINTERNAL_H_ */