Donatien Garnier / HTTPClient_ToBeRemoved

HTTP Client library

Dependents:   weather_LCD_display News_LCD_display TwitterExample_1 GeoLocation_LCD_Display ... more

LPC2368/services/http/client/HTTPClient.h@0:a828ace1f38d, 2010-06-11 (annotated)

Committer:
donatien
Date:
Fri Jun 11 16:25:51 2010 +0000
Revision:
0:a828ace1f38d
Child:
5:d0be6af2d1db

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew 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

0:a828ace1f38d


    24

#ifndef HTTP_CLIENT_H





donatien

0:a828ace1f38d


    25

#define HTTP_CLIENT_H





donatien

0:a828ace1f38d


    26







donatien

0:a828ace1f38d


    27

class HTTPData;





donatien

0:a828ace1f38d


    28







donatien

0:a828ace1f38d


    29

#include "if/net/net.h"





donatien

0:a828ace1f38d


    30

#include "api/TCPSocket.h"





donatien

0:a828ace1f38d


    31

#include "api/DNSRequest.h"





donatien

0:a828ace1f38d


    32

#include "HTTPData.h"





donatien

0:a828ace1f38d


    33

#include "mbed.h"





donatien

0:a828ace1f38d


    34







donatien

0:a828ace1f38d


    35

#include <string>





donatien

0:a828ace1f38d


    36

using std::string;





donatien

0:a828ace1f38d


    37







donatien

0:a828ace1f38d


    38

#include <map>





donatien

0:a828ace1f38d


    39

using std::map;





donatien

0:a828ace1f38d


    40







donatien

0:a828ace1f38d


    41

enum HTTPResult





donatien

0:a828ace1f38d


    42

{





donatien

0:a828ace1f38d


    43

  HTTP_OK,





donatien

0:a828ace1f38d


    44

  HTTP_PROCESSING,





donatien

0:a828ace1f38d


    45

  HTTP_PARSE, //URI Parse error





donatien

0:a828ace1f38d


    46

  HTTP_DNS, //Could not resolve name





donatien

0:a828ace1f38d


    47

  HTTP_PRTCL, //Protocol error





donatien

0:a828ace1f38d


    48

  HTTP_NOTFOUND, //404 Error





donatien

0:a828ace1f38d


    49

  HTTP_REFUSED, //403 Error





donatien

0:a828ace1f38d


    50

  HTTP_ERROR, //xxx error





donatien

0:a828ace1f38d


    51

  HTTP_TIMEOUT, //Connection timeout





donatien

0:a828ace1f38d


    52

  HTTP_CONN //Connection error





donatien

0:a828ace1f38d


    53

};





donatien

0:a828ace1f38d


    54







donatien

0:a828ace1f38d


    55







donatien

0:a828ace1f38d


    56







donatien

0:a828ace1f38d


    57

class HTTPClient : protected NetService





donatien

0:a828ace1f38d


    58

{





donatien

0:a828ace1f38d


    59

public:





donatien

0:a828ace1f38d


    60

  HTTPClient();





donatien

0:a828ace1f38d


    61

  virtual ~HTTPClient();





donatien

0:a828ace1f38d


    62

  





donatien

0:a828ace1f38d


    63

  void basicAuth(const char* user, const char* password); //Basic Authentification





donatien

0:a828ace1f38d


    64

  





donatien

0:a828ace1f38d


    65

  //High Level setup functions





donatien

0:a828ace1f38d


    66

  HTTPResult get(const char* uri, HTTPData* pDataIn); //Blocking





donatien

0:a828ace1f38d


    67

  HTTPResult get(const char* uri, HTTPData* pDataIn, void (*pMethod)(HTTPResult)); //Non blocking





donatien

0:a828ace1f38d


    68

  template<class T> 





donatien

0:a828ace1f38d


    69

  HTTPResult get(const char* uri, HTTPData* pDataIn, T* pItem, void (T::*pMethod)(HTTPResult)) //Non blocking





donatien

0:a828ace1f38d


    70

  {





donatien

0:a828ace1f38d


    71

    setOnResult(pItem, pMethod);





donatien

0:a828ace1f38d


    72

    doGet(uri, pDataIn);





donatien

0:a828ace1f38d


    73

    return HTTP_PROCESSING;





donatien

0:a828ace1f38d


    74

  }





donatien

0:a828ace1f38d


    75

  





donatien

0:a828ace1f38d


    76

  HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn); //Blocking





donatien

0:a828ace1f38d


    77

  HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn, void (*pMethod)(HTTPResult)); //Non blocking





donatien

0:a828ace1f38d


    78

  template<class T> 





donatien

0:a828ace1f38d


    79

  HTTPResult post(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn, T* pItem, void (T::*pMethod)(HTTPResult)) //Non blocking  





donatien

0:a828ace1f38d


    80

  {





donatien

0:a828ace1f38d


    81

    setOnResult(pItem, pMethod);





donatien

0:a828ace1f38d


    82

    doPost(uri, dataOut, pDataIn);





donatien

0:a828ace1f38d


    83

    return HTTP_PROCESSING;





donatien

0:a828ace1f38d


    84

  }





donatien

0:a828ace1f38d


    85

  





donatien

0:a828ace1f38d


    86

  void doGet(const char* uri, HTTPData* pDataIn);  





donatien

0:a828ace1f38d


    87

  void doPost(const char* uri, const HTTPData& dataOut, HTTPData* pDataIn); 





donatien

0:a828ace1f38d


    88

  





donatien

0:a828ace1f38d


    89

  void setOnResult( void (*pMethod)(HTTPResult) );





donatien

0:a828ace1f38d


    90

  class CDummy;





donatien

0:a828ace1f38d


    91

  template<class T> 





donatien

0:a828ace1f38d


    92

  //Linker bug : Must be defined here :(





donatien

0:a828ace1f38d


    93

  void setOnResult( T* pItem, void (T::*pMethod)(HTTPResult) )





donatien

0:a828ace1f38d


    94

  {





donatien

0:a828ace1f38d


    95

    m_pCb = NULL;





donatien

0:a828ace1f38d


    96

    m_pCbItem = (CDummy*) pItem;





donatien

0:a828ace1f38d


    97

    m_pCbMeth = (void (CDummy::*)(HTTPResult)) pMethod;





donatien

0:a828ace1f38d


    98

  }





donatien

0:a828ace1f38d


    99

  





donatien

0:a828ace1f38d


   100

  void setTimeout(int ms);





donatien

0:a828ace1f38d


   101

  





donatien

0:a828ace1f38d


   102

  virtual void poll(); //Called by NetServices





donatien

0:a828ace1f38d


   103

  





donatien

0:a828ace1f38d


   104

  int getHTTPResponseCode();





donatien

0:a828ace1f38d


   105

  void setRequestHeader(const string& header, const string& value);





donatien

0:a828ace1f38d


   106

  string& getResponseHeader(const string& header);





donatien

0:a828ace1f38d


   107

  void resetRequestHeaders();





donatien

0:a828ace1f38d


   108

  





donatien

0:a828ace1f38d


   109

protected:





donatien

0:a828ace1f38d


   110

  void resetTimeout();





donatien

0:a828ace1f38d


   111

  





donatien

0:a828ace1f38d


   112

  void init();





donatien

0:a828ace1f38d


   113

  void close();





donatien

0:a828ace1f38d


   114

  





donatien

0:a828ace1f38d


   115

  void setup(const char* uri, HTTPData* pDataOut, HTTPData* pDataIn); //Setup request, make DNS Req if necessary





donatien

0:a828ace1f38d


   116

  void connect(); //Start Connection





donatien

0:a828ace1f38d


   117

  





donatien

0:a828ace1f38d


   118

  int  tryRead(); //Read data and try to feed output





donatien

0:a828ace1f38d


   119

  void readData(); //Data has been read





donatien

0:a828ace1f38d


   120

  void writeData(); //Data has been written & buf is free





donatien

0:a828ace1f38d


   121

  





donatien

0:a828ace1f38d


   122

  void onTCPSocketEvent(TCPSocketEvent e);





donatien

0:a828ace1f38d


   123

  void onDNSReply(DNSReply r);





donatien

0:a828ace1f38d


   124

  void onResult(HTTPResult r); //Called when exchange completed or on failure





donatien

0:a828ace1f38d


   125

  void onTimeout(); //Connection has timed out





donatien

0:a828ace1f38d


   126

  





donatien

0:a828ace1f38d


   127

private:





donatien

0:a828ace1f38d


   128

  HTTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available





donatien

0:a828ace1f38d


   129







donatien

0:a828ace1f38d


   130

  bool readHeaders(); //Called first when receiving data





donatien

0:a828ace1f38d


   131

  bool writeHeaders(); //Called to create req





donatien

0:a828ace1f38d


   132

  int readLine(char* str, int maxLen, bool* pIncomplete = NULL);





donatien

0:a828ace1f38d


   133

  





donatien

0:a828ace1f38d


   134

  enum HTTP_METH





donatien

0:a828ace1f38d


   135

  {





donatien

0:a828ace1f38d


   136

    HTTP_GET,





donatien

0:a828ace1f38d


   137

    HTTP_POST,





donatien

0:a828ace1f38d


   138

    HTTP_HEAD





donatien

0:a828ace1f38d


   139

  };





donatien

0:a828ace1f38d


   140

  





donatien

0:a828ace1f38d


   141

  HTTP_METH m_meth;





donatien

0:a828ace1f38d


   142

  





donatien

0:a828ace1f38d


   143

  CDummy* m_pCbItem;





donatien

0:a828ace1f38d


   144

  void (CDummy::*m_pCbMeth)(HTTPResult);





donatien

0:a828ace1f38d


   145

  





donatien

0:a828ace1f38d


   146

  void (*m_pCb)(HTTPResult);





donatien

0:a828ace1f38d


   147

  





donatien

0:a828ace1f38d


   148

  TCPSocket* m_pTCPSocket;





donatien

0:a828ace1f38d


   149

  map<string, string> m_reqHeaders;





donatien

0:a828ace1f38d


   150

  map<string, string> m_respHeaders;





donatien

0:a828ace1f38d


   151

  





donatien

0:a828ace1f38d


   152

  Timer m_watchdog;





donatien

0:a828ace1f38d


   153

  int m_timeout;





donatien

0:a828ace1f38d


   154

  





donatien

0:a828ace1f38d


   155

  DNSRequest* m_pDnsReq;





donatien

0:a828ace1f38d


   156

  





donatien

0:a828ace1f38d


   157

  Host m_server;





donatien

0:a828ace1f38d


   158

  string m_path;





donatien

0:a828ace1f38d


   159

  





donatien

0:a828ace1f38d


   160

  bool m_closed;





donatien

0:a828ace1f38d


   161

  





donatien

0:a828ace1f38d


   162

  enum HTTPStep





donatien

0:a828ace1f38d


   163

  {





donatien

0:a828ace1f38d


   164

   // HTTP_INIT,





donatien

0:a828ace1f38d


   165

    HTTP_WRITE_HEADERS,





donatien

0:a828ace1f38d


   166

    HTTP_WRITE_DATA,





donatien

0:a828ace1f38d


   167

    HTTP_READ_HEADERS,





donatien

0:a828ace1f38d


   168

    HTTP_READ_DATA,





donatien

0:a828ace1f38d


   169

    HTTP_READ_DATA_INCOMPLETE,





donatien

0:a828ace1f38d


   170

    HTTP_DONE,





donatien

0:a828ace1f38d


   171

    HTTP_CLOSED





donatien

0:a828ace1f38d


   172

  };





donatien

0:a828ace1f38d


   173

  





donatien

0:a828ace1f38d


   174

  HTTPStep m_state;





donatien

0:a828ace1f38d


   175

  





donatien

0:a828ace1f38d


   176

  HTTPData* m_pDataOut;





donatien

0:a828ace1f38d


   177

  HTTPData* m_pDataIn;





donatien

0:a828ace1f38d


   178

  





donatien

0:a828ace1f38d


   179

  bool m_dataChunked; //Data is encoded as chunks





donatien

0:a828ace1f38d


   180

  int m_dataPos; //Position in data





donatien

0:a828ace1f38d


   181

  int m_dataLen; //Data length





donatien

0:a828ace1f38d


   182

  char* m_buf;





donatien

0:a828ace1f38d


   183

  char* m_pBufRemaining; //Remaining





donatien

0:a828ace1f38d


   184

  int m_bufRemainingLen; //Data length in m_pBufRemaining





donatien

0:a828ace1f38d


   185

  





donatien

0:a828ace1f38d


   186

  int m_httpResponseCode;





donatien

0:a828ace1f38d


   187

  





donatien

0:a828ace1f38d


   188

  HTTPResult m_blockingResult; //Result if blocking mode





donatien

0:a828ace1f38d


   189

  





donatien

0:a828ace1f38d


   190

};





donatien

0:a828ace1f38d


   191







donatien

0:a828ace1f38d


   192

//Including data containers here for more convenience





donatien

0:a828ace1f38d


   193

#include "data/HTTPFile.h"





donatien

0:a828ace1f38d


   194

#include "data/HTTPStream.h"





donatien

0:a828ace1f38d


   195

#include "data/HTTPText.h"





donatien

0:a828ace1f38d


   196

#include "data/HTTPMap.h"





donatien

0:a828ace1f38d


   197







donatien

0:a828ace1f38d


   198

#endif