* 2. Hyphens are expected at positions {9, 14, 19, 24}.
* 3. The rest charcters should be simple xdigits.
*
- * @param[i] uuid
- * uuid extracted from uri
+ * @param[in] uuid uuid extracted from uri
+ *
* @retval true for success, otherwise false and an error is logged
*/
bool OCIsUUID(const char *uuid);
/**
* This function return zone id related from ifindex and address.
*
- * @param ifindex[in] interface index.
- * @param zoneId[out] pointer of zoneId string.
+ * @param[in] ifindex interface index.
+ * @param[out] zoneId pointer of zoneId string.
*
* @return ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM
*/
/**
* return scope level of given ip address.
- * @param[in] address remote address.
- * @param[out] scope level of given ip address.
+ * @param[in] addr remote address.
+ * @param[out] scopeLevel scope level of given ip address.
* @return ::CA_STATUS_OK or Appropriate error code.
*/
CAResult_t CAGetIpv6AddrScope(const char *addr, CATransportFlags_t *scopeLevel);
* API for Virtual Resource("/oic/d" and "/oic/p") Publish to Resource Directory.
* @note This API applies to resource server side only.
*
- * @param host Host IP Address of a service to direct resource publish query.
+ * @param host Host IP Address of a service to direct resource publish query.
* @param connectivityType ::OCConnectivityType type of connectivity.
- * @param callback Handles callbacks, success states and failure states.
+ * @param resourceHandles This is the resource handle which we need to register to RD.
+ * @param callback Handles callbacks, success states and failure states.
*
* @return Returns ::OC_STACK_OK if success.
*/
* API for published resource delete from Resource Directory.
* @note This API applies to resource server side only.
*
- * @param host Host IP Address of a service to direct resource delete query.
+ * @param host Host IP Address of a service to direct resource delete query.
* @param connectivityType ::OCConnectivityType type of connectivity.
- * @param callback Handles callbacks, success states and failure states.
+ * @param resourceHandles This is the resource handle which we need to register to RD.
+ * @param callback Handles callbacks, success states and failure states.
*
* @return Returns ::OC_STACK_OK if success.
*/
* the payload using routingmessageparser apis, addition or removal of
* Gateway entries is performed.
* @param[in] devAddr Address of the Device that sent the payload.
- * @param[in] resource Response payload.
+ * @param[in] payload Response payload.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RMHandleResponsePayload(const OCDevAddr *devAddr, const OCRepPayload *payload);
uint32_t RMGetGatewayId();
/**
- * API to get the multicast sequence number..
+ * API to get the multicast sequence number.
* @return Multicast sequence number.
*/
uint16_t RMGetMcastSeqNumber();
* On reception of request from CA, RI sends to this function.
* This checks if the route option is present and adds routing information to
* to the route option data.
- * @param[in,out] message Received coap packet.
- * @param[in] sender RemoteEndpoint which sent the packet.
- * @param[out] destination Populated by RM by parsing message, CA then forwards packet to
- * "destination".
- * @param[out] isEmptyMsg Populated by RM by parsing the RouteOption. If the MSGType is ACK
- * in route option and is for self, then this flag is set.
+ * @param[in,out] message Received coap packet.
+ * @param[in] sender RemoteEndpoint which sent the packet.
+ * @param[out] selfDestination Populated by RM by parsing message, CA then forwards packet to
+ * "destination".
+ * @param[out] isEmptyMsg Populated by RM by parsing the RouteOption. If the MSGType is ACK
+ * in route option and is for self, then this flag is set.
* @return ::CA_STATUS_OK or Appropriate error code.
*/
OCStackResult RMHandleRequest(CARequestInfo_t *message, const CAEndpoint_t *sender,
* On reception of response from CA, RI sends to this function.
* This checks if the route option is present and adds routing information to
* to the route option data.
- * @param[in,out] message Received coap packet.
- * @param[in] sender RemoteEndpoint which sent the packet.
- * @param[out] destination Populated by RM by parsing message to know if response is
- * for its own.
+ * @param[in,out] message Received coap packet.
+ * @param[in] sender RemoteEndpoint which sent the packet.
+ * @param[out] selfDestination Populated by RM by parsing message to know if response is
+ * for its own.
* @return ::CA_STATUS_OK or Appropriate error code.
*/
OCStackResult RMHandleResponse(CAResponseInfo_t *message, const CAEndpoint_t *sender,
/**
* Parse payload for response and get required info.
* @param[in] payload Payload with gateways route table encoded.
- * @param[in/out] seqNum Sequence Number of Gateway.
- * @param[in/out] gatewayId Gateway Id.
- * @param[in/out] gatewayTable Parsed routing table from Payload.
+ * @param[in,out] gatewayId Gateway Id.
+ * @param[in,out] seqNum Sequence Number of Gateway.
+ * @param[in,out] gatewayTable Parsed routing table from Payload.
* @param[out] isUpdateSeqNeeded Response type of payload response/notification.
* @return ::OC_STACK_OK or Appropriate error code.
*/
/**
* Frees payload.
- * @param[in/out] payload Encoded Payload for Gateway ID.
+ * @param[in,out] payload Encoded Payload for Gateway ID.
*/
void RMPFreePayload(OCRepPayload *payload);
/**
* Initialize the Routing Table Manager.
- * @param[in/out] gatewayTable Gateway Routing Table.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMInitialize(u_linklist_t **gatewayTable, u_linklist_t **endpointTable);
/**
* Terminates the Routing Table Manager.
- * @param[in/out] gatewayTable Gateway Routing Table.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMTerminate(u_linklist_t **gatewayTable, u_linklist_t **endpointTable);
/**
* Frees the gateway table memory with nodes containing structure RTMGatewayEntry_t.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMFreeGatewayRouteTable(u_linklist_t **gatewayTable);
/**
* Frees the gateway ID list memory with nodes containing structute RTMGatewayId_t.
- * @param[in/out] gatewayIdTable Gateway ID list.
+ * @param[in,out] gatewayIdTable Gateway ID list.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMFreeGatewayIdList(u_linklist_t **gatewayIdTable);
/**
* Frees the endpoint table memory with nodes containing structute RTMEndpointEntry_t.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMFreeEndpointRouteTable(u_linklist_t **endpointTable);
* @param[in] nextHop Next Hop address.
* @param[in] routeCost Shortest Path to Destination - Hopcount.
* @param[in] destInterfaces Destination Interface Information.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMAddGatewayEntry(uint32_t gatewayId, uint32_t nextHop, uint32_t routeCost,
/**
* Adds the endpoint entry to the routing table.
- * @param[in/out] endpointId Endpoint Id.
+ * @param[in,out] endpointId Endpoint Id.
* @param[in] destAddr Destination Address.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMAddEndpointEntry(uint16_t *endpointId, const CAEndpoint_t *destAddr,
* Removes the gateway entry from the routing table and also removes
* corresponding entries having nexthop as removed gateway.
* @param[in] gatewayId Gateway id of node need to be removed.
- * @param[in/out] removedGatewayNodes Linklist containing removed gateway nodes
+ * @param[in,out] removedGatewayNodes Linklist containing removed gateway nodes
* list need to be freed by caller.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveGatewayEntry(uint32_t gatewayId, u_linklist_t **removedGatewayNodes,
/**
* Removes the endpoint entry from the routing table.
* @param[in] endpointId Endpoint id of node need to be removed.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveEndpointEntry(uint16_t endpointId, u_linklist_t **endpointTable);
* @param[in] gatewayId Gateway Id.
* @param[in] nextHop Next Hop address.
* @param[in] destInfAdr Destination Address of Next Hop to update time.
- * @param[in/out] existEntry Entry which has different Next Hop.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] existEntry Entry which has different Next Hop.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveGatewayDestEntry(uint32_t gatewayId, uint32_t nextHop,
RTMGatewayEntry_t **existEntry, u_linklist_t **gatewayTable);
/**
* Removes the gateway nodes.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveGateways(u_linklist_t **gatewayTable);
/**
* Removes the endpoint nodes.
- * @param[in/out] endpointTable Endpoint Routing Table.
+ * @param[in,out] endpointTable Endpoint Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveEndpoints(u_linklist_t **endpointTable);
/**
* Gets the neighbor nodes i.e nodes with routecost 1.
- * @param[in/out] neighbourNodes link list containing neighbor nodes.
+ * @param[in,out] neighbourNodes link list containing neighbor nodes.
this list will be pointer to GatewayIds
and must be freed by caller.
* @param[in] gatewayTable Gateway Routing Table.
* @param[in] gatewayId Gateway Id of Hop need to be updated.
* @param[in] destInterfaces Destination Interface Information.
* @param[in] addAdr Add/Remove destination address.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMUpdateDestinationIntfAdr(uint32_t gatewayId, RTMDestIntfInfo_t destInterfaces,
* Updates Multicast sequence number for gatewayID
* @param[in] gatewayId Gateway Id of Hop need to be updated.
* @param[in] seqNum Sequence number for last cast packet from gateway.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMUpdateMcastSeqNumber(uint32_t gatewayId, uint16_t seqNum,
/**
* Frees the GatewayId
* @param[in] gateway Gateway Structure pointer.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
*/
void RTMFreeGateway(RTMGatewayId_t *gateway, u_linklist_t **gatewayTable);
/**
* Gets the list of observer IDs.
- * @param[in/out] obsList List of Observation IDs.
- * @param[in/out] obsListLen Length if Observation ID list.
+ * @param[in,out] obsList List of Observation IDs.
+ * @param[in,out] obsListLen Length if Observation ID list.
* @param[in] gatewayTable Gateway Routing Table.
*/
void RTMGetObserverList(OCObservationId **obsList, uint8_t *obsListLen,
* Adds a observer address and obsID to the list.
* @param[in] obsID Observation ID.
* @param[in] devAddr Address of Gateway.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMAddObserver(uint32_t obsID, CAEndpoint_t devAddr, u_linklist_t **gatewayTable);
* Check if a particular observer address is already registerd and returns
* its obsID if present.
* @param[in] devAddr Address of Gateway.
- * @param[in/out] obsID Observation ID.
+ * @param[in,out] obsID Observation ID.
* @param[in] gatewayTable Gateway Routing Table.
* @return true or false.
*/
/**
* Update Gateway Address Validity.
- * @param[in/out] invalidTable Removed entries Table.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] invalidTable Removed entries Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMUpdateDestAddrValidity(u_linklist_t **invalidTable, u_linklist_t **gatewayTable);
/**
* Removes invalid gateways.
- * @param[in/out] invalidTable Removed entries Table.
- * @param[in/out] gatewayTable Gateway Routing Table.
+ * @param[in,out] invalidTable Removed entries Table.
+ * @param[in,out] gatewayTable Gateway Routing Table.
* @return ::OC_STACK_OK or Appropriate error code.
*/
OCStackResult RTMRemoveInvalidGateways(u_linklist_t **invalidTable, u_linklist_t **gatewayTable);
* Update Sequence number of Gateway Entry.
* @param[in] gatewayId Gateway Id.
* @param[in] seqNum Sequence Number of Entry.
- * @param[in] destInterfaces Destination Interface Information.
+ * @param[in] destAdr Destination Interface Information.
* @param[out] gatewayTable Gateway Routing Table.
* @param[in] forceUpdate To Update parameters forcefully.
* @return ::OC_STACK_OK or Appropriate error code.
* Adds the destination address to the Route options.
* If Route option is already present, it adds the destination address information to
* Route option else creates a new Route option with the destination address info.
- * @param[in] endpoint Destination address.
+ * @param[in] destination Destination address.
* @param[in,out] message Request/response message to add the route option
* @param[in] isRequest True if message is request else false.
* @param[out] doPost True if a POST message be sent for empty packet to
* @param resource Observed resource.
* @param obsIdList List of observation ids that need to be notified.
* @param numberOfIds Number of observation ids included in obsIdList.
- * @param notificationJSONPayload JSON encoded payload to send in notification.
+ * @param payload JSON encoded payload to send in notification.
* @param maxAge Time To Live (in seconds) of observation.
* @param qos Desired quality of service of the observation notifications.
*
*/
char *attrName;
- /** value of the attribute as void. To support both string and @OCStringLL value*/
+ /** value of the attribute as void. To support both string and ::OCStringLL value*/
void *attrValue;
} OCAttribute;
bool IsVirtualResource(const char* resourceUri);
/**
- * Parameter @ref handling returns by-reference the type of resource handling
- * required by the internal stack based on the specified @ref request.
+ * Parameter handling returns by-reference the type of resource handling
+ * required by the internal stack based on the specified request.
+ *
+ * @param request the OCServerRequest to the internal stack
+ * @param handling the resource handling required by the internal stack
+ * @param resource the OCResource from the stack
+ *
* @return ::OC_STACK_OK for Success, otherwise some error value
*/
OCStackResult DetermineResourceHandling (const OCServerRequest *request,
OCResource **resource);
/**
- * Processes the specified @ref request based on the type of resource handling
- * @ref resHandling.
+ * Processes the specified request based on the type of resource handling
+ * resHandling.
+ *
+ * @param resHandling the type of resource handling to be used
+ * @param resource the resource to process the request on
+ * @param request the request to process
+ *
* @return ::OC_STACK_OK for Success, otherwise some error value.
*/
OCStackResult ProcessRequest(ResourceHandling resHandling,
* @param qos Request QOS.
* @param query Request query.
* @param rcvdVendorSpecificHeaderOptions Received vendor specific header options.
- * @param reqJSONPayload Request JSON payload.
+ * @param payload Request JSON payload.
* @param requestToken Request token.
* @param tokenLength Request token length.
* @param resourceUrl URL of resource.
/**
* Delete all of the dynamically allocated elements that were created for the resource attributes.
*
- * @param resourceAttr Specified resource attribute.
+ * @param rsrcAttributes Specified resource attribute.
*/
void OCDeleteResourceAttributes(OCAttribute *rsrcAttributes);
*
* @param payload Pointer to the payload from which byte string array needs to be retrieved.
* @param name Name of the byte string array.
- * @param value Byte string array.
+ * @param array Byte string array.
* @param dimensions Number of byte strings in above array.
*
* @note: Caller needs to invoke OICFree on 'bytes' field of all array elements after it is
* all the device in subnet which support direct-pairing.
* Caller must NOT free returned constant pointer
*
- * @param[in] timeout Timeout in seconds, value till which function will listen to responses from
- * client before returning the list of devices.
+ * @param[in] waittime Timeout in seconds, value till which function will listen to responses from
+ * client before returning the list of devices.
* @return OCDirectPairingDev_t pointer in case of success and NULL otherwise.
*/
const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime);
* The function is responsible for establishment of direct-pairing. It will proceed mode negotiation
* and connect PIN based dtls session.
*
+ * @param[in] ctx user context passed back with resultCallback.
* @param[in] peer Target device to establish direct-pairing.
* @param[in] pmSel Selected mode of pairing.
* @param[in] pinNumber PIN number for authentication, pin lenght is defined DP_PIN_LENGTH(8).
/**
* This function return link local zone id related from ifindex.
*
-* @param ifindex[in] interface index.
-* @param zoneId[out] pointer of zoneId string, caller should free
+* @param[in] ifindex interface index.
+* @param[out] zoneId pointer of zoneId string, caller should free
* zoneId using OICFree() when it returned CA_STATUS_OK.
* @return Returns ::OC_STACK_OK if success.
*/
# with spaces.
INPUT = . \
+ ../../csdk/include/octypes.h \
../../csdk/stack/include/ocstack.h \
- ../../csdk/stack/include/octypes.h \
../../csdk/stack/include/ocpayload.h \
../../csdk/stack/include/ocpresence.h \
../../csdk/stack/include/payload_logging.h \
../../include/OCResourceResponse.h \
../../include/OCResource.h \
../../include/OCProvisioningManager.hpp \
- ../../csdk/stack/include/octypes.h \
+ ../../csdk/include/octypes.h \
../../csdk/stack/include/ocstackconfig.h \
guides \
../../../service/resource-encapsulation/include \
/**
* Request to discover to remote address as parameter.
- * @param[in] server address combined with IP address and port number using delimiter :
+ * @param[in] serverAddress combined with IP address and port number using delimiter :
* @return ::NS_OK or result code of NSResult
*/
NSResult NSConsumerEnableRemoteService(const char * serverAddress);
#ifdef WITH_MQ
/**
* Request to subscribe to remote MQ address as parameter.
- * @param[in] server address combined with IP address and port number and MQ broker uri using delimiter :
+ * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :
* @param[in] topicName the interest MQ Topic name for subscription.
* @return ::NS_OK or result code of NSResult
*/
\r
/**\r
* Request to publish resource using remote relay server\r
- * @param[in] server address combined with IP address and port number using delimiter :\r
+ * @param[in] serverAddress server address combined with IP address and port number using delimiter :\r
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.\r
*/\r
NSResult NSProviderEnableRemoteService(char * serverAddress);\r
\r
/**\r
* Request to terminate remote service from relay server\r
- * @param[in] server address combined with IP address and port number using delimiter :\r
+ * @param[in] serverAddress server address combined with IP address and port number using delimiter :\r
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.\r
*/\r
NSResult NSProviderDisableRemoteService(char * serverAddress);\r
#ifdef WITH_MQ\r
/**\r
* Request to subscribe to remote MQ address as parameter.\r
- * @param[in] server address combined with IP address and port number and MQ broker uri using delimiter :\r
+ * @param[in] serverAddress server address combined with IP address and port number and MQ broker uri using delimiter :\r
* @param[in] topicName the interest Topic name for subscription.\r
* @return ::NS_OK or result code of NSResult\r
*/\r
\r
/**\r
* Send notification message to all subscribers\r
- * @param[in] message Notification message including id, title, contentText\r
+ * @param[in] msg Notification message including id, title, contentText\r
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.\r
*/\r
NSResult NSSendMessage(NSMessage * msg);\r
/**\r
* Send acceptance to consumer who subscribes the resource of notification message\r
* This function is valid only when subControllability is set true.\r
- * @param[in] consumer Consumer who subscribes the resource\r
- * @param[in] accepted the result of acceptance; ALLOW or DENY\r
+ * @param[in] consumerId Consumer who subscribes the resource\r
+ * @param[in] accepted the result of acceptance; ALLOW or DENY\r
* @return ::NS_OK if this function is requested succesfully\r
* or NS_FAIL if subContollability is false.\r
*/\r
\r
/**\r
* Send synchronizad state of notificaion message to consumers\r
- * @param[in] messageiId ID of notification message\r
+ * @param[in] messageId ID of notification message\r
* @param[in] type SyncType of the syncInfo message\r
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.\r
*/\r
\r
/**\r
* Request topic list with selection state for the consumer\r
- * @param[in] consumerid the id of consumer which topic list is subscribed for\r
+ * @param[in] consumerId the id of consumer which topic list is subscribed for\r
* @return :: Topic list\r
*/\r
NSTopicLL * NSProviderGetConsumerTopics(const char * consumerId);\r