HTTP Client library
Dependents: weather_LCD_display News_LCD_display TwitterExample_1 GeoLocation_LCD_Display ... more
Diff: LPC1768/services/http/client/data/HTTPMap.h
- Revision:
- 5:d0be6af2d1db
- Parent:
- 0:a828ace1f38d
diff -r 76ca2a4fa528 -r d0be6af2d1db LPC1768/services/http/client/data/HTTPMap.h --- a/LPC1768/services/http/client/data/HTTPMap.h Fri Jul 09 14:35:21 2010 +0000 +++ b/LPC1768/services/http/client/data/HTTPMap.h Thu Aug 05 15:09:46 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +HTTP Map data source/sink header file +*/ + #ifndef HTTP_MAP_H #define HTTP_MAP_H @@ -32,15 +36,29 @@ typedef map<string, string> Dictionary; +///HTTP Client data container for key/value pairs +/** +This class simplifies the use of key/value pairs requests and responses used widely among web APIs. +Note that HTTPMap inherits from std::map<std::string,std::string>. +You can therefore use any public method of that class, including the square brackets operator ( [ ] ) to access a value. + +The data is encoded or decoded to/from a key/value pairs-formatted string, after url-encoding/decoding. +*/ class HTTPMap : public HTTPData, public Dictionary //Key/Value pairs { public: + ///Instantiates map + /** + @param keyValueSep Key/Value separator (defaults to "=") + @param pairSep Pairs separator (defaults to "&") + */ HTTPMap(const string& keyValueSep = "=", const string& pairSep = "&"); virtual ~HTTPMap(); /* string& operator[](const string& key); int count();*/ + ///Clears the content virtual void clear(); protected: