X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..b0edecea489b62db69eb74ca8f7623132cceab54:/interface/wx/protocol/http.h diff --git a/interface/wx/protocol/http.h b/interface/wx/protocol/http.h index fbd65f3b5d..cdad04236d 100644 --- a/interface/wx/protocol/http.h +++ b/interface/wx/protocol/http.h @@ -11,6 +11,8 @@ wxHTTP can be used to establish a connection to an HTTP server. + wxHTTP can thus be used to create a (basic) HTTP @b client. + @library{wxnet} @category{net} @@ -20,14 +22,36 @@ class wxHTTP : public wxProtocol { public: /** - Returns the data attached with a field whose name is specified by @e header. + Default constructor. + */ + wxHTTP(); + + /** + Destructor will close the connection if connected. + */ + virtual ~wxHTTP(); + + //@{ + /** + Connect to the HTTP server. + + By default, connection is made to the port 80 of the specified @a host. + You may connect to a non-default port by specifying it explicitly using + the second overload. + */ + virtual bool Connect(const wxString& host); + virtual bool Connect(const wxString& host, unsigned short port); + //@} + + /** + Returns the data attached with a field whose name is specified by @a header. If the field doesn't exist, it will return an empty string and not a @NULL string. @note The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type" represent the same header. */ - wxString GetHeader(const wxString& header); + wxString GetHeader(const wxString& header) const; /** Creates a new input stream on the specified path. @@ -52,7 +76,7 @@ public: @see wxInputStream */ - wxInputStream* GetInputStream(const wxString& path); + virtual wxInputStream* GetInputStream(const wxString& path); /** Returns the HTTP response code returned by the server. @@ -64,7 +88,7 @@ public: /** It sets data of a field to be sent during the next request to the HTTP server. - The field name is specified by @a header and the content by @e h_data. + The field name is specified by @a header and the content by @a h_data. This is a low level function and it assumes that you know what you are doing. */ void SetHeader(const wxString& header, const wxString& h_data);