Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/services/http/client/data/HTTPMap.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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