mbed Connector Interface simplification API on top of mbed-client
Fork of mbedConnectorInterfaceV3 by
NOTE:
This repo has been replaced with https://github.com/ARMmbed/mbedConnectorInterface. No further updates will occur with this repo. Please use the github repo instead. Thanks!
Diff: mbed-connector-interface/StaticResource.h
- Revision:
- 27:b8aaf7dc7023
- Parent:
- 0:1f1f55e73248
--- a/mbed-connector-interface/StaticResource.h Sun Jun 12 03:18:25 2016 +0000 +++ b/mbed-connector-interface/StaticResource.h Tue Jun 14 04:01:34 2016 +0000 @@ -1,100 +1,97 @@ -/** - * @file StaticResource.h - * @brief mbed CoAP Endpoint Static Resource class - * @author Doug Anson/Chris Paola - * @version 1.0 - * @see - * - * Copyright (c) 2014 - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#ifndef __STATIC_RESOURCE_H__ -#define __STATIC_RESOURCE_H__ - -// Base Class -#include "mbed-connector-interface/Resource.h" - -// String class support -#include <string> - -// DataWrapper support -#include "mbed-connector-interface/DataWrapper.h" - -/** StaticResource is a static (GET only) resource with a value type pinned as a string type - */ -class StaticResource : public Resource<string> -{ -public: - /** - Default constructor - @param logger input logger instance for this resource - @param obj_name input the Object - @param res_name input the Resource URI/Name - @param value input the Resource value (a string) - */ - StaticResource(const Logger *logger,const char *obj_name,const char *res_name,const char *value); - - /** - string value constructor - @param logger input logger instance for this resource - @param obj_name input the Object - @param name input the Resource URI/Name - @param value input the Resource value (a string) - */ - StaticResource(const Logger *logger,const char *obj_name,const char *res_name,const string value); - - /** - constructor with buffer lengths - @param logger input logger instance for this resource - @param obj_name input the Object - @param name input the Resource URI/Name - #param name_length input the length of the Resource URI/Name - @param value input the Resource value (or NULL) - */ - StaticResource(const Logger *logger,const string obj_name,const string res_name,const string value); - - /** - Copy constructor - @param resource input the StaticResource that is to be deep copied - */ - StaticResource(const StaticResource &resource); - - /** - Destructor - */ - virtual ~StaticResource(); - - /** - Bind resource to endpoint - @param p input pointer to the endpoint resources necessary for binding - */ - virtual M2MObject *bind(void *p); - - /** - Set the data wrapper - @param data_wrapper input the data wrapper instance - */ - void setDataWrapper(DataWrapper *data_wrapper) { this->m_data_wrapper = data_wrapper; } - -protected: - DataWrapper *getDataWrapper() { return this->m_data_wrapper; } - -private: - DataWrapper *m_data_wrapper; - M2MObject *m_object; -}; - -#endif // __STATIC_RESOURCE_H__ +/** + * @file StaticResource.h + * @brief mbed CoAP Endpoint Static Resource class + * @author Doug Anson/Chris Paola + * @version 1.0 + * @see + * + * Copyright (c) 2014 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef __STATIC_RESOURCE_H__ +#define __STATIC_RESOURCE_H__ + +// Base Class +#include "mbed-connector-interface/Resource.h" + +// DataWrapper support +#include "mbed-connector-interface/DataWrapper.h" + +/** StaticResource is a static (GET only) resource with a value type pinned as a string type + */ +class StaticResource : public Resource<string> +{ +public: + /** + Default constructor + @param logger input logger instance for this resource + @param obj_name input the Object + @param res_name input the Resource URI/Name + @param value input the Resource value (a string) + */ + StaticResource(const Logger *logger,const char *obj_name,const char *res_name,const char *value); + /** + string value constructor + @param logger input logger instance for this resource + @param obj_name input the Object + @param name input the Resource URI/Name + @param value input the Resource value (a string) + */ + StaticResource(const Logger *logger,const char *obj_name,const char *res_name,const string value); + + /** + constructor with buffer lengths + @param logger input logger instance for this resource + @param obj_name input the Object + @param name input the Resource URI/Name + #param name_length input the length of the Resource URI/Name + @param value input the Resource value (or NULL) + */ + StaticResource(const Logger *logger,const string obj_name,const string res_name,const string value); + + /** + Copy constructor + @param resource input the StaticResource that is to be deep copied + */ + StaticResource(const StaticResource &resource); + + /** + Destructor + */ + virtual ~StaticResource(); + + /** + Bind resource to endpoint + @param ep input endpoint instance pointer + */ + virtual void bind(void *ep); + + /** + Set the data wrapper + @param data_wrapper input the data wrapper instance + */ + void setDataWrapper(DataWrapper *data_wrapper) { this->m_data_wrapper = data_wrapper; } + +protected: + DataWrapper *getDataWrapper() { return this->m_data_wrapper; } + +private: + DataWrapper *m_data_wrapper; + M2MResource *m_res; +}; + +#endif // __STATIC_RESOURCE_H__ +