Doug Anson / mbedConnectorInterface

mbed Connector Endpoint interface. This interface permits a mbed endpoint to easily setup MDS resources and emit those resources to an MDS server.

Dependents:   IoT_LED_demo ServoTest uWater_Project hackathon ... more

api/StaticResource.h@0:b438482ebbfc, 2015-01-27 (annotated)

Committer:
ansond
Date:
Tue Jan 27 22:23:51 2015 +0000
Revision:
0:b438482ebbfc
Child:
2:853f9ecc12df
initial check in

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:b438482ebbfc 1 /**
ansond 0:b438482ebbfc 2 * @file StaticResource.h
ansond 0:b438482ebbfc 3 * @brief mbed CoAP Endpoint Static Resource class
ansond 0:b438482ebbfc 4 * @author Doug Anson/Chris Paola
ansond 0:b438482ebbfc 5 * @version 1.0
ansond 0:b438482ebbfc 6 * @see
ansond 0:b438482ebbfc 7 *
ansond 0:b438482ebbfc 8 * Copyright (c) 2014
ansond 0:b438482ebbfc 9 *
ansond 0:b438482ebbfc 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 0:b438482ebbfc 11 * you may not use this file except in compliance with the License.
ansond 0:b438482ebbfc 12 * You may obtain a copy of the License at
ansond 0:b438482ebbfc 13 *
ansond 0:b438482ebbfc 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 0:b438482ebbfc 15 *
ansond 0:b438482ebbfc 16 * Unless required by applicable law or agreed to in writing, software
ansond 0:b438482ebbfc 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 0:b438482ebbfc 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 0:b438482ebbfc 19 * See the License for the specific language governing permissions and
ansond 0:b438482ebbfc 20 * limitations under the License.
ansond 0:b438482ebbfc 21 */
ansond 0:b438482ebbfc 22
ansond 0:b438482ebbfc 23 #ifndef __STATIC_RESOURCE_H__
ansond 0:b438482ebbfc 24 #define __STATIC_RESOURCE_H__
ansond 0:b438482ebbfc 25
ansond 0:b438482ebbfc 26 // Base Class
ansond 0:b438482ebbfc 27 #include "Resource.h"
ansond 0:b438482ebbfc 28
ansond 0:b438482ebbfc 29 // String class support
ansond 0:b438482ebbfc 30 #include <string>
ansond 0:b438482ebbfc 31
ansond 0:b438482ebbfc 32 // StaticResource is a static (GET only) resource with a value type pinned as a string type
ansond 0:b438482ebbfc 33 class StaticResource : public Resource<string> {
ansond 0:b438482ebbfc 34 public:
ansond 0:b438482ebbfc 35 /**
ansond 0:b438482ebbfc 36 Default constructor
ansond 0:b438482ebbfc 37 @param logger input logger instance for this resource
ansond 0:b438482ebbfc 38 @param name input the Resource URI/Name
ansond 0:b438482ebbfc 39 @param value input the Resource value (a string)
ansond 0:b438482ebbfc 40 */
ansond 0:b438482ebbfc 41 StaticResource(const Logger *logger,const char *name,const char *value);
ansond 0:b438482ebbfc 42
ansond 0:b438482ebbfc 43 /**
ansond 0:b438482ebbfc 44 string value constructor
ansond 0:b438482ebbfc 45 @param logger input logger instance for this resource
ansond 0:b438482ebbfc 46 @param name input the Resource URI/Name
ansond 0:b438482ebbfc 47 @param value input the Resource value (a string)
ansond 0:b438482ebbfc 48 */
ansond 0:b438482ebbfc 49 StaticResource(const Logger *logger,const char *name,const string value);
ansond 0:b438482ebbfc 50
ansond 0:b438482ebbfc 51 /**
ansond 0:b438482ebbfc 52 constructor with buffer lengths
ansond 0:b438482ebbfc 53 @param logger input logger instance for this resource
ansond 0:b438482ebbfc 54 @param name input the Resource URI/Name
ansond 0:b438482ebbfc 55 #param name_length input the length of the Resource URI/Name
ansond 0:b438482ebbfc 56 @param value input the Resource value (or NULL)
ansond 0:b438482ebbfc 57 */
ansond 0:b438482ebbfc 58 StaticResource(const Logger *logger,const string name,const string value);
ansond 0:b438482ebbfc 59
ansond 0:b438482ebbfc 60 /**
ansond 0:b438482ebbfc 61 Copy constructor
ansond 0:b438482ebbfc 62 @param resource input the StaticResource that is to be deep copied
ansond 0:b438482ebbfc 63 */
ansond 0:b438482ebbfc 64 StaticResource(const StaticResource &resource);
ansond 0:b438482ebbfc 65
ansond 0:b438482ebbfc 66 /**
ansond 0:b438482ebbfc 67 Destructor
ansond 0:b438482ebbfc 68 */
ansond 0:b438482ebbfc 69 virtual ~StaticResource();
ansond 0:b438482ebbfc 70
ansond 0:b438482ebbfc 71 /**
ansond 0:b438482ebbfc 72 Bind resource to endpoint
ansond 0:b438482ebbfc 73 @param p input pointer to the endpoint resources necessary for binding
ansond 0:b438482ebbfc 74 */
ansond 0:b438482ebbfc 75 virtual void bind(void *p);
ansond 0:b438482ebbfc 76
ansond 0:b438482ebbfc 77 protected:
ansond 0:b438482ebbfc 78
ansond 0:b438482ebbfc 79 private:
ansond 0:b438482ebbfc 80 };
ansond 0:b438482ebbfc 81
ansond 0:b438482ebbfc 82 #endif // __STATIC_RESOURCE_H__