interface/wx/protocol/http.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        protocol/http.h
   3 // Purpose:     interface of wxHTTP
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxHTTP
  11
  12     wxHTTP can be used to establish a connection to an HTTP server.
  13
  14     wxHTTP can thus be used to create a (basic) HTTP @b client.
  15
  16     @library{wxnet}
  17     @category{net}
  18
  19     @see wxSocketBase, wxURL
  20 */
  21 class wxHTTP : public wxProtocol
  22 {
  23 public:
  24     /**
  25         Default constructor.
  26     */
  27     wxHTTP();
  28
  29     /**
  30         Destructor will close the connection if connected.
  31     */
  32     virtual ~wxHTTP();
  33
  34     //@{
  35     /**
  36         Connect to the HTTP server.
  37
  38         By default, connection is made to the port 80 of the specified @a host.
  39         You may connect to a non-default port by specifying it explicitly using
  40         the second overload.
  41      */
  42     virtual bool Connect(const wxString& host);
  43     virtual bool Connect(const wxString& host, unsigned short port);
  44     //@}
  45
  46     /**
  47         Returns the data attached with a field whose name is specified by @a header.
  48         If the field doesn't exist, it will return an empty string and not a @NULL string.
  49
  50         @note
  51         The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type"
  52         represent the same header.
  53     */
  54     wxString GetHeader(const wxString& header) const;
  55
  56     /**
  57         Creates a new input stream on the specified path.
  58
  59         Notice that this stream is unseekable, i.e. SeekI() and TellI() methods
  60         shouldn't be used.
  61
  62         Note that you can still know the size of the file you are getting using
  63         wxStreamBase::GetSize(). However there is a limitation: in HTTP protocol,
  64         the size is not always specified so sometimes @c (size_t)-1 can returned to
  65         indicate that the size is unknown.
  66         In such case, you may want to use wxInputStream::LastRead() method in a loop
  67         to get the total size.
  68
  69         @return Returns the initialized stream. You must delete it yourself
  70                  once you don't use it anymore and this must be done before
  71                  the wxHTTP object itself is destroyed. The destructor
  72                  closes the network connection. The next time you will
  73                  try to get a file the network connection will have to
  74                  be reestablished, but you don't have to take care of
  75                  this since wxHTTP reestablishes it automatically.
  76
  77         @see wxInputStream
  78     */
  79     virtual wxInputStream* GetInputStream(const wxString& path);
  80
  81     /**
  82         Returns the HTTP response code returned by the server.
  83
  84         Please refer to RFC 2616 for the list of responses.
  85     */
  86     int GetResponse() const;
  87
  88     /**
  89         It sets data of a field to be sent during the next request to the HTTP server.
  90
  91         The field name is specified by @a header and the content by @a h_data.
  92         This is a low level function and it assumes that you know what you are doing.
  93     */
  94     void SetHeader(const wxString& header, const wxString& h_data);
  95 };
  96