]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/protocol/http.h
Doc and comment cleanup, fixes, tweaks
[wxWidgets.git] / interface / wx / protocol / http.h
index 6cd1332ae82e5308cc9cbb05b26fbf99a366f25e..8251655264035cd7d4c8c65b280b0d4079256cf6 100644 (file)
@@ -8,7 +8,6 @@
 
 /**
     @class wxHTTP
-    @headerfile http.h wx/protocol/http.h
 
     wxHTTP can be used to establish a connection to an HTTP server.
 
 class wxHTTP : public wxProtocol
 {
 public:
+    //@{
+    /**
+        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.
+     */
+    bool Connect(const wxString& host);
+    bool Connect(const wxString& host, unsigned short port);
+    //@}
+
     /**
         Returns the data attached with a field whose name is specified by @e header.
         If the field doesn't exist, it will return an empty string and not a @NULL string.
@@ -28,7 +39,7 @@ public:
         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.
@@ -53,14 +64,14 @@ public:
 
         @see wxInputStream
     */
-    wxInputStream* GetInputStream(const wxString& path);
+    virtual wxInputStream* GetInputStream(const wxString& path);
 
     /**
         Returns the HTTP response code returned by the server.
 
         Please refer to RFC 2616 for the list of responses.
     */
-    int GetResponse() const;
+    int GetResponse();
 
     /**
         It sets data of a field to be sent during the next request to the HTTP server.