Commit 3040f83f authored by George Nash's avatar George Nash Committed by Dan Mihai

Fixed documentation warnings for c-docs

Fixed all of the documentation warnings found when running
Doxygen for the C documentation.

All of the documentation warnings fell into 3 areas:
1. Error using the @param[in,out] syntax
2. @param did not match the actual parameter name
3. Paramerter was missing documentation all together

For  case 3 an attempt to provide the best documentation
was done based on context. In a few situations the parameter
documentation is just restating the type of parameter being
passed in.

Change-Id: I06797a471dcefaaa2d9b50dc44ca4228cfafb941
Signed-off-by: George Nash's avatarGeorge Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/17543Tested-by: default avatarjenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: default avatarDan Mihai <Daniel.Mihai@microsoft.com>
parent 5343a1b8
......@@ -115,8 +115,8 @@ bool OCConvertStringToUuid(const char uuidString[UUID_STRING_SIZE],
* 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);
......
......@@ -253,8 +253,8 @@ CAResult_t CASetProxyUri(const char *uri);
/**
* 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
*/
......
......@@ -260,8 +260,8 @@ CAResult_t CAUtilSetBTConfigure(CAUtilConfig_t config);
/**
* 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);
......
......@@ -67,9 +67,10 @@ public:
* 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.
*/
......@@ -93,9 +94,10 @@ public:
* 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.
*/
......
......@@ -62,7 +62,7 @@ OCStackResult RMHandleGatewayRequest(OCServerRequest *request, const OCResource
* 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);
......@@ -86,7 +86,7 @@ OCStackResult RMGetGatewayPayload(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();
......@@ -95,12 +95,12 @@ 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,
......@@ -110,10 +110,10 @@ OCStackResult RMHandleRequest(CARequestInfo_t *message, const CAEndpoint_t *send
* 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,
......
......@@ -83,9 +83,9 @@ OCStackResult RMPParseRequestPayload(const uint8_t* payload, size_t payloadSize,
/**
* 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.
*/
......@@ -95,7 +95,7 @@ OCStackResult RMPParseResponsePayload(const OCRepPayload *payload, uint32_t *gat
/**
* Frees payload.
* @param[in/out] payload Encoded Payload for Gateway ID.
* @param[in,out] payload Encoded Payload for Gateway ID.
*/
void RMPFreePayload(OCRepPayload *payload);
......
......@@ -113,37 +113,37 @@ typedef struct
/**
* 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);
......@@ -158,7 +158,7 @@ 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,
......@@ -166,9 +166,9 @@ OCStackResult RTMAddGatewayEntry(uint32_t gatewayId, uint32_t nextHop, uint32_t
/**
* 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,
......@@ -178,9 +178,9 @@ OCStackResult RTMAddEndpointEntry(uint16_t *endpointId, const CAEndpoint_t *dest
* 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,
......@@ -189,7 +189,7 @@ OCStackResult RTMRemoveGatewayEntry(uint32_t gatewayId, u_linklist_t **removedGa
/**
* 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);
......@@ -199,8 +199,8 @@ OCStackResult RTMRemoveEndpointEntry(uint16_t endpointId, u_linklist_t **endpoin
* @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,
......@@ -208,21 +208,21 @@ 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.
......@@ -251,7 +251,7 @@ CAEndpoint_t *RTMGetEndpointEntry(uint16_t endpointId, const u_linklist_t *endpo
* @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,
......@@ -261,7 +261,7 @@ OCStackResult RTMUpdateDestinationIntfAdr(uint32_t gatewayId, RTMDestIntfInfo_t
* 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,
......@@ -277,14 +277,14 @@ void RTMPrintTable(const u_linklist_t *gatewayTable, const u_linklist_t *endpoin
/**
* 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,
......@@ -294,7 +294,7 @@ 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);
......@@ -303,7 +303,7 @@ OCStackResult RTMAddObserver(uint32_t obsID, CAEndpoint_t devAddr, u_linklist_t
* 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.
*/
......@@ -318,16 +318,16 @@ uint64_t RTMGetCurrentTime();
/**
* 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);
......@@ -336,7 +336,7 @@ OCStackResult RTMRemoveInvalidGateways(u_linklist_t **invalidTable, u_linklist_t
* 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.
......
......@@ -117,7 +117,7 @@ void RMSetStackMode(OCMode mode);
* 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
......
......@@ -136,7 +136,7 @@ OCStackResult SendAllObserverNotification (OCMethod method, OCResource *resPtr,
* @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.
*
......
......@@ -144,7 +144,7 @@ typedef struct attr_t {
*/
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;
......
......@@ -150,8 +150,13 @@ OCResource *FindResourceByUri(const char* resourceUri);
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,
......@@ -159,8 +164,13 @@ 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,
......
......@@ -208,7 +208,7 @@ OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
* @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.
......
......@@ -324,7 +324,7 @@ OCStackResult OCUpdateResourceInsWithResponse(const char *requestUri,
/**
* 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);
......
......@@ -181,7 +181,7 @@ bool OCRepPayloadSetByteStringArray(OCRepPayload* payload, const char* name,
*
* @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
......
......@@ -646,8 +646,8 @@ OCStackResult OCDoResponse(OCEntityHandlerResponse *response);
* 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);
......@@ -665,6 +665,7 @@ const OCDPDev_t* OCGetDirectPairedDevices();
* 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).
......@@ -870,8 +871,8 @@ OCPersistentStorage *OCGetPersistentStorageHandler();
/**
* 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.
*/
......
......@@ -660,8 +660,8 @@ WARN_LOGFILE = ./doxygen.log
# 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 \
......
......@@ -668,7 +668,7 @@ INPUT = . \
../../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 \
......
......@@ -79,7 +79,7 @@ NSResult NSStopConsumer();
/**
* 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);
......@@ -87,7 +87,7 @@ 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
*/
......
......@@ -86,14 +86,14 @@ NSResult NSStopProvider();
/**
* Request to publish resource using remote relay server
* @param[in] server address combined with IP address and port number using delimiter :
* @param[in] serverAddress server address combined with IP address and port number using delimiter :
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.
*/
NSResult NSProviderEnableRemoteService(char * serverAddress);
/**
* Request to terminate remote service from relay server
* @param[in] server address combined with IP address and port number using delimiter :
* @param[in] serverAddress server address combined with IP address and port number using delimiter :
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.
*/
NSResult NSProviderDisableRemoteService(char * serverAddress);
......@@ -101,7 +101,7 @@ NSResult NSProviderDisableRemoteService(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 Topic name for subscription.
* @return ::NS_OK or result code of NSResult
*/
......@@ -110,7 +110,7 @@ NSResult NSProviderSubscribeMQService(const char * serverAddress, const char * t
/**
* Send notification message to all subscribers
* @param[in] message Notification message including id, title, contentText
* @param[in] msg Notification message including id, title, contentText
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.
*/
NSResult NSSendMessage(NSMessage * msg);
......@@ -118,8 +118,8 @@ NSResult NSSendMessage(NSMessage * msg);
/**
* Send acceptance to consumer who subscribes the resource of notification message
* This function is valid only when subControllability is set true.
* @param[in] consumer Consumer who subscribes the resource
* @param[in] accepted the result of acceptance; ALLOW or DENY
* @param[in] consumerId Consumer who subscribes the resource
* @param[in] accepted the result of acceptance; ALLOW or DENY
* @return ::NS_OK if this function is requested succesfully
* or NS_FAIL if subContollability is false.
*/
......@@ -127,7 +127,7 @@ NSResult NSAcceptSubscription(const char * consumerId, bool accepted);
/**
* Send synchronizad state of notificaion message to consumers
* @param[in] messageiId ID of notification message
* @param[in] messageId ID of notification message
* @param[in] type SyncType of the syncInfo message
* @return ::NS_OK if the action is requested succesfully or NS_FAIL if wrong parameter is set.
*/
......@@ -172,7 +172,7 @@ NSResult NSProviderUnsetConsumerTopic(const char * consumerId, const char * topi
/**
* Request topic list with selection state for the consumer
* @param[in] consumerid the id of consumer which topic list is subscribed for
* @param[in] consumerId the id of consumer which topic list is subscribed for
* @return :: Topic list
*/
NSTopicLL * NSProviderGetConsumerTopics(const char * consumerId);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment