Donatien Garnier
HTTP Client library
Dependents: weather_LCD_display News_LCD_display TwitterExample_1 GeoLocation_LCD_Display ... more
LPC2368/services/http/client/data/HTTPMap.h@5:d0be6af2d1db, 2010-08-05 (annotated)
- Committer:
- donatien
- Date:
- Thu Aug 05 15:09:46 2010 +0000
- Revision:
- 5:d0be6af2d1db
- Parent:
- 0:a828ace1f38d
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:a828ace1f38d | 1 | |
| donatien | 0:a828ace1f38d | 2 | /* |
| donatien | 0:a828ace1f38d | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:a828ace1f38d | 4 | |
| donatien | 0:a828ace1f38d | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:a828ace1f38d | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:a828ace1f38d | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:a828ace1f38d | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:a828ace1f38d | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:a828ace1f38d | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:a828ace1f38d | 11 | |
| donatien | 0:a828ace1f38d | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:a828ace1f38d | 13 | all copies or substantial portions of the Software. |
| donatien | 0:a828ace1f38d | 14 | |
| donatien | 0:a828ace1f38d | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:a828ace1f38d | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:a828ace1f38d | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:a828ace1f38d | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:a828ace1f38d | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:a828ace1f38d | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:a828ace1f38d | 21 | THE SOFTWARE. |
| donatien | 0:a828ace1f38d | 22 | */ |
| donatien | 0:a828ace1f38d | 23 | |
| donatien | 5:d0be6af2d1db | 24 | /** \file |
| donatien | 5:d0be6af2d1db | 25 | HTTP Map data source/sink header file |
| donatien | 5:d0be6af2d1db | 26 | */ |
| donatien | 5:d0be6af2d1db | 27 | |
| donatien | 0:a828ace1f38d | 28 | #ifndef HTTP_MAP_H |
| donatien | 0:a828ace1f38d | 29 | #define HTTP_MAP_H |
| donatien | 0:a828ace1f38d | 30 | |
| donatien | 0:a828ace1f38d | 31 | #include "../HTTPData.h" |
| donatien | 0:a828ace1f38d | 32 | #include "mbed.h" |
| donatien | 0:a828ace1f38d | 33 | |
| donatien | 0:a828ace1f38d | 34 | #include <map> |
| donatien | 0:a828ace1f38d | 35 | using std::map; |
| donatien | 0:a828ace1f38d | 36 | |
| donatien | 0:a828ace1f38d | 37 | typedef map<string, string> Dictionary; |
| donatien | 0:a828ace1f38d | 38 | |
| donatien | 5:d0be6af2d1db | 39 | ///HTTP Client data container for key/value pairs |
| donatien | 5:d0be6af2d1db | 40 | /** |
| donatien | 5:d0be6af2d1db | 41 | This class simplifies the use of key/value pairs requests and responses used widely among web APIs. |
| donatien | 5:d0be6af2d1db | 42 | Note that HTTPMap inherits from std::map<std::string,std::string>. |
| donatien | 5:d0be6af2d1db | 43 | You can therefore use any public method of that class, including the square brackets operator ( [ ] ) to access a value. |
| donatien | 5:d0be6af2d1db | 44 | |
| donatien | 5:d0be6af2d1db | 45 | The data is encoded or decoded to/from a key/value pairs-formatted string, after url-encoding/decoding. |
| donatien | 5:d0be6af2d1db | 46 | */ |
| donatien | 0:a828ace1f38d | 47 | class HTTPMap : public HTTPData, public Dictionary //Key/Value pairs |
| donatien | 0:a828ace1f38d | 48 | { |
| donatien | 0:a828ace1f38d | 49 | public: |
| donatien | 5:d0be6af2d1db | 50 | ///Instantiates map |
| donatien | 5:d0be6af2d1db | 51 | /** |
| donatien | 5:d0be6af2d1db | 52 | @param keyValueSep Key/Value separator (defaults to "=") |
| donatien | 5:d0be6af2d1db | 53 | @param pairSep Pairs separator (defaults to "&") |
| donatien | 5:d0be6af2d1db | 54 | */ |
| donatien | 0:a828ace1f38d | 55 | HTTPMap(const string& keyValueSep = "=", const string& pairSep = "&"); |
| donatien | 0:a828ace1f38d | 56 | virtual ~HTTPMap(); |
| donatien | 0:a828ace1f38d | 57 | |
| donatien | 0:a828ace1f38d | 58 | /* string& operator[](const string& key); |
| donatien | 0:a828ace1f38d | 59 | int count();*/ |
| donatien | 0:a828ace1f38d | 60 | |
| donatien | 5:d0be6af2d1db | 61 | ///Clears the content |
| donatien | 0:a828ace1f38d | 62 | virtual void clear(); |
| donatien | 0:a828ace1f38d | 63 | |
| donatien | 0:a828ace1f38d | 64 | protected: |
| donatien | 0:a828ace1f38d | 65 | virtual int read(char* buf, int len); |
| donatien | 0:a828ace1f38d | 66 | virtual int write(const char* buf, int len); |
| donatien | 0:a828ace1f38d | 67 | |
| donatien | 0:a828ace1f38d | 68 | virtual string getDataType(); //Internet media type for Content-Type header |
| donatien | 0:a828ace1f38d | 69 | virtual void setDataType(const string& type); //Internet media type from Content-Type header |
| donatien | 0:a828ace1f38d | 70 | |
| donatien | 0:a828ace1f38d | 71 | virtual bool getIsChunked(); //For Transfer-Encoding header |
| donatien | 0:a828ace1f38d | 72 | virtual void setIsChunked(bool chunked); //From Transfer-Encoding header |
| donatien | 0:a828ace1f38d | 73 | |
| donatien | 0:a828ace1f38d | 74 | virtual int getDataLen(); //For Content-Length header |
| donatien | 0:a828ace1f38d | 75 | virtual void setDataLen(int len); //From Content-Length header |
| donatien | 0:a828ace1f38d | 76 | |
| donatien | 0:a828ace1f38d | 77 | private: |
| donatien | 0:a828ace1f38d | 78 | void generateString(); |
| donatien | 0:a828ace1f38d | 79 | void parseString(); |
| donatien | 0:a828ace1f38d | 80 | //map<string, string> m_map; |
| donatien | 0:a828ace1f38d | 81 | string m_buf; |
| donatien | 0:a828ace1f38d | 82 | int m_len; |
| donatien | 0:a828ace1f38d | 83 | bool m_chunked; |
| donatien | 0:a828ace1f38d | 84 | |
| donatien | 0:a828ace1f38d | 85 | string m_keyValueSep; |
| donatien | 0:a828ace1f38d | 86 | string m_pairSep; |
| donatien | 0:a828ace1f38d | 87 | }; |
| donatien | 0:a828ace1f38d | 88 | |
| donatien | 0:a828ace1f38d | 89 | #endif |