document wxFont(wxString) ctor

[wxWidgets.git] / interface / wx / protocol / protocol.h

diff --git a/interface/wx/protocol/protocol.h b/interface/wx/protocol/protocol.h
index abb6277ecd1788bdd20957b525a58ce784f40d5c..dc1586ac52883e4280eb13b0c26a569ceee9d1e7 100644 (file)
--- a/interface/wx/protocol/protocol.h
+++ b/interface/wx/protocol/protocol.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        protocol/protocol.h
+// Name:        wx/protocol/protocol.h

 // Purpose:     interface of wxProtocol
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxProtocol
 // Author:      wxWidgets team
 // RCS-ID:      $Id$


@@ -28,6 +28,10 @@ enum wxProtocolError
 
     Represents a protocol for use with wxURL.
 
 
     Represents a protocol for use with wxURL.
 

+    Note that you may want to change the default time-out for HTTP/FTP connections
+    and network operations (using SetDefaultTimeout()) since the default time-out
+    value is quite long (60 seconds).
+

     @library{wxnet}
     @category{net}
 
     @library{wxnet}
     @category{net}
 


@@ -45,19 +49,20 @@ public:
 
         @return Returns @true, if successful, else @false.
     */
 
         @return Returns @true, if successful, else @false.
     */

-    bool Abort();
+    virtual bool Abort() = 0;

 
     /**
         Returns the type of the content of the last opened stream. It is a mime-type.
 
     /**
         Returns the type of the content of the last opened stream. It is a mime-type.

+        May be an empty string if the content-type is unknown.

     */
     */

-    wxString GetContentType();
+    virtual wxString GetContentType() const;

 
     /**
         Returns the last occurred error.
 
         @see wxProtocolError
     */
 
     /**
         Returns the last occurred error.
 
         @see wxProtocolError
     */

-    wxProtocolError GetError();
+    virtual wxProtocolError GetError() const;

 
     /**
         Creates a new input stream on the specified path.
 
     /**
         Creates a new input stream on the specified path.


@@ -74,7 +79,7 @@ public:
 
         @see wxInputStream
     */
 
         @see wxInputStream
     */

-    wxInputStream* GetInputStream(const wxString& path);
+    virtual wxInputStream* GetInputStream(const wxString& path) = 0;

 
     /**
         Tries to reestablish a previous opened connection (close and renegotiate
 
     /**
         Tries to reestablish a previous opened connection (close and renegotiate


@@ -85,13 +90,67 @@ public:
     bool Reconnect();
 
     /**
     bool Reconnect();
 
     /**

-        Sets the authentication password. It is mainly useful when FTP is used.
+        Sets the authentication password.
+    */
+    virtual void SetPassword(const wxString& user);
+
+    /**
+        Sets the authentication user.
+    */
+    virtual void SetUser(const wxString& user);
+
+    /**
+        Sets a new default timeout for the network operations.
+
+        The default timeout is 60 seconds.
+
+        @see wxSocketBase::SetTimeout

     */
     */

-    void SetPassword(const wxString& user);
+    void SetDefaultTimeout(wxUint32 Value);

 
     /**
 
     /**

-        Sets the authentication user. It is mainly useful when FTP is used.
+        @name Logging support.
+
+        Each wxProtocol object may have the associated logger (by default there
+        is none) which is used to log network requests and responses.
+
+        @see wxProtocolLog

     */
     */

-    void SetUser(const wxString& user);
+    //@{
+
+    /**
+        Set the logger, deleting the old one and taking ownership of this one.
+
+        @param log
+            New logger allocated on the heap or @NULL.
+     */
+    void SetLog(wxProtocolLog *log);
+
+    /**
+        Return the current logger, may be @NULL.
+     */
+    wxProtocolLog *GetLog() const { return m_log; }
+
+    /**
+        Detach the existing logger without deleting it.
+        
+        The caller is responsible for deleting the returned pointer if it's
+        non-@c NULL.
+     */
+    wxProtocolLog *DetachLog();
+
+    /**
+        Call wxProtocolLog::LogRequest() if we have a valid logger or do
+        nothing otherwise.
+     */
+    void LogRequest(const wxString& str);
+
+    /**
+        Call wxProtocolLog::LogResponse() if we have a valid logger or do
+        nothing otherwise.
+     */
+    void LogResponse(const wxString& str);
+
+    //@}

 };
 
 };