/**
* Discovers resources of interest, regardless of uri and resource type.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param cb A callback to obtain discovered resource
/**
* Discovers resources of interest, regardless of resource type.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param relativeUri The relative uri of resource to be searched
/**
* Discovers resources of interest by resource type.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param resourceType Resource Type
const std::string& resourceType, ResourceDiscoveredCallback cb);
/**
- * Discovers resources of interest by resource type.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * Discovers resources of interest by resource types.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param resourceTypes List of Resource Types
* @param cb A callback to obtain discovered resource
*
* @throws InvalidParameterException If cb is empty.
- * @throws InvalidParameterException If resourceType's size is than 2,
- * at least one of resource type is empty.
+ * @throws RCSBadRequestException If resourceTypes contain more than one element and
+ * any of them is empty.
*
* @note The callback will be invoked in an internal thread.
* @note If resourceTypes is empty, discovers resource by all resource types.
ResourceDiscoveredCallback cb);
/**
- * Discovers resources of interest by resource types with provided relativeUri.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * Discovers resources of interest by a resource type with provided relativeUri.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param relativeUri The relative uri of resource to be searched
/**
* Discovers resources of interest by resource types with provided relativeUri.
- * It is Consistently discovering resources until the discovery task is canceled.
+ * It will consistently discover resources until the discovery task is canceled.
*
* @param address A RCSAddress object
* @param relativeUri The relative uri of resource to be searched
* @param cb A callback to obtain discovered resource
*
* @throws InvalidParameterException If cb is empty.
- * @throws InvalidParameterException If resourceType's size is than 2,
- * at least one of resource type is empty.
+ * @throws RCSBadRequestException If resourceTypes contain more than one element and
+ * any of them is empty.
*
* @note The callback will be invoked in an internal thread.
* @note If resourceTypes is empty, discovers resource by all resource types.
class PrimitiveResource;
+ /**
+ * This is to specify query parameters for requests to the server.
+ *
+ * @see RCSRemoteResourceObject
+ */
class RCSQueryParams
{
public:
typedef std::unordered_map< std::string, std::string > Map;
public:
- RCSQueryParams& setResourceInterface(const std::string&);
- RCSQueryParams& setResourceInterface(std::string&&);
- RCSQueryParams& setResuorceType(const std::string&);
- RCSQueryParams& setResuorceType(std::string&&);
+ /**
+ * Sets an interface of the resource to operate on
+ *
+ * @param interface interface
+ */
+ RCSQueryParams& setResourceInterface(std::string interface);
+
+ /**
+ * Sets a resource type of the resource to operate on
+ *
+ * @param type resource type
+ */
+ RCSQueryParams& setResourceType(std::string type);
- RCSQueryParams& put(const std::string&, const std::string&);
- RCSQueryParams& put(std::string&&, std::string&&);
- RCSQueryParams& put(const std::string&, std::string&&);
- RCSQueryParams& put(std::string&&, const std::string&);
+ /**
+ * Sets a resource type of the resource to operate on
+ *
+ * @param key key to be inserted
+ * @param value value to be inserted
+ *
+ * @note "rt" and "if" are reserved, so you should avoid them as a key.
+ *
+ */
+ RCSQueryParams& put(std::string key, std::string value);
+ /**
+ * Returns the resource interface.
+ */
std::string getResourceInterface() const;
+
+ /**
+ * Returns the resource type.
+ */
std::string getResourceType() const;
- std::string get(const std::string&) const;
+ /**
+ * Returns a value.
+ *
+ * @param key key of the element whose mapped value is accessed.
+ *
+ * @throws InvalidKeyException If @a key doesn't match the key of any value.
+ */
+ std::string get(const std::string& key) const;
+
+ /**
+ * Returns all params.
+ */
const Map& getAll() const;
private:
typedef std::function< void(const RCSResourceAttributes& attrs, int eCode) >
RemoteAttributesGetCallback;
- typedef std::function< void(const HeaderOpts&, const RCSRepresentation& rep, int eCode) >
- GetCallback;
+ /**
+ * Callback definition to be invoked when the response of get is received.
+ *
+ * @param HeaderOpts
+ * @param rep the result representation
+ * @param eCode the error code received from the resource
+ *
+ * @see get
+ */
+ typedef std::function< void(const HeaderOpts& headerOpts,
+ const RCSRepresentation& rep, int eCode) > GetCallback;
/**
* Callback definition to be invoked when the response of setRemoteAttributes is
*
* @see setRemoteAttributes
*/
- typedef std::function< void(const RCSResourceAttributes&, int) >
+ typedef std::function< void(const RCSResourceAttributes& attrs, int eCode) >
RemoteAttributesSetCallback;
- typedef std::function< void(const HeaderOpts&, const RCSRepresentation& rep, int eCode) >
- SetCallback;
+ /**
+ * Callback definition to be invoked when the response of set is received.
+ *
+ * @param HeaderOpts
+ * @param rep the result representation
+ * @param eCode the error code received from the resource
+ *
+ * @see set
+ */
+ typedef std::function< void(const HeaderOpts& headerOpts,
+ const RCSRepresentation& rep, int eCode) > SetCallback;
private:
typedef int CacheID;
~RCSRemoteResourceObject();
- static RCSRemoteResourceObject::Ptr fromOCResource(std::shared_ptr< OC::OCResource >);
+ /**
+ * Creates an instance from an OCResource instance.
+ *
+ * @throw RCSInvalidParameterException If ocResource is nullptr.
+ */
+ static RCSRemoteResourceObject::Ptr fromOCResource(
+ std::shared_ptr< OC::OCResource > ocResource);
/**
* Returns whether monitoring is enabled.
* Gets resource attributes directly from the server.
*
* This API send a get request to the resource of interest and provides
- * the attributes to the caller in the RemoteAttributesReceivedCallback.
+ * the attributes to the caller in the RemoteAttributesGetCallback.
*
* @throws PlatformException If the operation failed
* @throws InvalidParameterException If cb is an empty function or null.
*
- * @see RCSResourceAttributes::Value
- *
* @note The callback will be invoked in an internal thread.
*/
void getRemoteAttributes(RemoteAttributesGetCallback cb);
+ /**
+ * Gets resource representation with empty query parameters directly from the server.
+ *
+ * @param cb A callback to receive the response.
+ *
+ * @throws PlatformException If the operation failed
+ * @throws InvalidParameterException If cb is an empty function or null.
+ *
+ * @note The callback will be invoked in an internal thread.
+ */
void get(GetCallback cb);
- void get(const RCSQueryParams&, GetCallback cb);
+
+ /**
+ * Gets resource representation directly from the server.
+ *
+ * The response could be different by the query parameters, it depends on server.
+ *
+ * @param queryParams Query parameters
+ * @param cb A callback to receive the response.
+ *
+ * @throws PlatformException If the operation failed
+ * @throws InvalidParameterException If cb is an empty function or null.
+ *
+ * @note The callback will be invoked in an internal thread.
+ */
+ void get(const RCSQueryParams& queryParams, GetCallback cb);
/**
* Sends a set request with resource attributes to the server.
void setRemoteAttributes(const RCSResourceAttributes& attributes,
RemoteAttributesSetCallback cb);
+ /**
+ * Sends a set request with resource attributes to the server.
+ *
+ * The SetRequest behavior depends on query parameters and the server.
+ *
+ * @param attributes Attributes to set
+ * @param cb A callback to receive the response.
+ *
+ * @throws PlatformException If the operation failed
+ * @throws InvalidParameterException If cb is an empty function or null.
+ *
+ * @see RCSResourceObject
+ * @see RCSResourceObject::SetRequestHandlerPolicy
+ *
+ * @note The callback will be invoked in an internal thread.
+ */
void set(const RCSResourceAttributes& attributes, SetCallback cb);
- void set(const RCSQueryParams&, const RCSResourceAttributes& attributes, SetCallback cb);
+
+ /**
+ * Sends a set request with resource attributes to the server.
+ *
+ * The SetRequest behavior depends on query parameters and the server.
+ *
+ * @param queryParams Query parameters
+ * @param attributes Attributes to set
+ * @param cb A callback to receive the response.
+ *
+ * @throws PlatformException If the operation failed
+ * @throws InvalidParameterException If cb is an empty function or null.
+ *
+ * @see RCSResourceObject
+ * @see RCSResourceObject::SetRequestHandlerPolicy
+ *
+ * @note The callback will be invoked in an internal thread.
+ */
+ void set(const RCSQueryParams& queryParams, const RCSResourceAttributes& attributes,
+ SetCallback cb);
/**
* Returns the uri of the resource.
namespace Service
{
- RCSQueryParams& RCSQueryParams::setResourceInterface(const std::string& resourceInterface)
- {
- m_resourceInterface = resourceInterface;
- return *this;
- }
-
- RCSQueryParams& RCSQueryParams::setResourceInterface(std::string&& resourceInterface)
+ RCSQueryParams& RCSQueryParams::setResourceInterface(std::string resourceInterface)
{
m_resourceInterface = std::move(resourceInterface);
return *this;
}
- RCSQueryParams& RCSQueryParams::setResuorceType(const std::string& resourceType)
- {
- m_resourceType = resourceType;
- return *this;
- }
-
- RCSQueryParams& RCSQueryParams::setResuorceType(std::string&& resourceType)
+ RCSQueryParams& RCSQueryParams::setResourceType(std::string resourceType)
{
m_resourceType = std::move(resourceType);
return *this;
}
- RCSQueryParams& RCSQueryParams::put(const std::string& key, const std::string& value)
- {
- m_map[key] = value;
- return *this;
- }
-
- RCSQueryParams& RCSQueryParams::put(std::string&& key, std::string&& value)
+ RCSQueryParams& RCSQueryParams::put(std::string key, std::string value)
{
m_map[std::move(key)] = std::move(value);
return *this;
}
- RCSQueryParams& RCSQueryParams::put(const std::string& key, std::string&& value)
- {
- m_map[key] = std::move(value);
- return *this;
- }
-
- RCSQueryParams& RCSQueryParams::put(std::string&& key, const std::string& value)
- {
- m_map[std::move(key)] = value;
- return *this;
- }
-
std::string RCSQueryParams::getResourceInterface() const
{
return m_resourceInterface;
std::string RCSQueryParams::get(const std::string& key) const
{
- return m_map.at(key);
+ try
+ {
+ return m_map.at(key);
+ }
+ catch (const std::out_of_range&)
+ {
+ throw RCSInvalidKeyException(key + " is an invalid key");
+ }
}
const RCSQueryParams::Map& RCSQueryParams::getAll() const
RCSRemoteResourceObject::RCSRemoteResourceObject(
- std::shared_ptr< PrimitiveResource > pResource) :
- m_primitiveResource{ pResource },
+ std::shared_ptr< PrimitiveResource > primtiveResource) :
+ m_primitiveResource{ primtiveResource },
m_cacheId{ },
m_brokerId{ }
{
const auto& paramMap = queryParams.getAll();
- std::cout << queryParams.getResourceInterface() << "??\n";
-
m_primitiveResource->requestGetWith(
queryParams.getResourceType(), queryParams.getResourceInterface(),
OC::QueryParamsMap{ paramMap.begin(), paramMap.end() },
projects / platform / upstream / iotivity.git / commitdiff