revisions of o-p headers contributed by Utensil Candel and revised by me

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53118 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/protocol/ftp.h b/interface/protocol/ftp.h
index 8688cd6903a44eca13bca1172d1ba1955c497729..61ecaf18e9bdb57eeaa08571f0bd8b6f168e34dd 100644 (file)
--- a/interface/protocol/ftp.h
+++ b/interface/protocol/ftp.h
@@ -6,6 +6,16 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    Transfer modes used by wxFTP.
+*/
+enum TransferMode
+{
+    NONE,       //!< not set by user explicitly.
+    ASCII,
+    BINARY
+};
+

 /**
     @class wxFTP
     @headerfile ftp.h wx/protocol/ftp.h
 /**
     @class wxFTP
     @headerfile ftp.h wx/protocol/ftp.h


@@ -14,16 +24,16 @@
     usual operations. Please consult the RFC 959 for more details about the FTP
     protocol.
 
     usual operations. Please consult the RFC 959 for more details about the FTP
     protocol.
 

-    To use a commands which doesn't involve file transfer (i.e. directory oriented
+    To use a command which doesn't involve file transfer (i.e. directory oriented

     commands) you just need to call a corresponding member function or use the
     commands) you just need to call a corresponding member function or use the

-    generic wxFTP::SendCommand method. However to actually
-    transfer files you just get or give a stream to or from this class and the
-    actual data are read or written using the usual stream methods.
+    generic wxFTP::SendCommand() method.
+    However to actually transfer files you just get or give a stream to or from this
+    class and the actual data are read or written using the usual stream methods.

 
     Example of using wxFTP for file downloading:
 
     @code
 
     Example of using wxFTP for file downloading:
 
     @code

-    wxFTP ftp;
+        wxFTP ftp;

 
         // if you don't use these lines anonymous login will be used
         ftp.SetUser("user");
 
         // if you don't use these lines anonymous login will be used
         ftp.SetUser("user");


@@ -45,7 +55,7 @@
         {
             size_t size = in-GetSize();
             char *data = new char[size];
         {
             size_t size = in-GetSize();
             char *data = new char[size];

-            if ( !in-Read(data, size) )
+            if ( !in->Read(data, size) )

             {
                 wxLogError("Read error");
             }
             {
                 wxLogError("Read error");
             }


@@ -64,12 +74,12 @@
     successfully):
 
     @code
     successfully):
 
     @code

-    wxOutputStream *out = ftp.GetOutputStream("filename");
-            if ( out )
-            {
-                out-Write(...); // your data
-                delete out;
-            }
+        wxOutputStream *out = ftp.GetOutputStream("filename");
+        if ( out )
+        {
+            out->Write(...); // your data
+            delete out;
+        }

     @endcode
 
     @library{wxnet}
     @endcode
 
     @library{wxnet}


@@ -105,7 +115,7 @@ public:
     /**
         Send the specified @a command to the FTP server. @a ret specifies
         the expected result.
     /**
         Send the specified @a command to the FTP server. @a ret specifies
         the expected result.

-        
+

         @returns @true if the command has been sent successfully, else @false.
     */
     bool CheckCommand(const wxString& command, char ret);
         @returns @true if the command has been sent successfully, else @false.
     */
     bool CheckCommand(const wxString& command, char ret);


@@ -116,17 +126,31 @@ public:
     bool FileExists(const wxString& filename);
 
     /**
     bool FileExists(const wxString& filename);
 
     /**

-        The GetList function is quite low-level. It returns the list of the files in
+        The GetList() function is quite low-level. It returns the list of the files in

         the current directory. The list can be filtered using the @a wildcard string.
         the current directory. The list can be filtered using the @a wildcard string.

+

         If @a wildcard is empty (default), it will return all files in directory.
         The form of the list can change from one peer system to another. For example,
         for a UNIX peer system, it will look like this:
         If @a wildcard is empty (default), it will return all files in directory.
         The form of the list can change from one peer system to another. For example,
         for a UNIX peer system, it will look like this:

-        
+
+        @verbatim
+        -r--r--r--   1 guilhem  lavaux      12738 Jan 16 20:17 cmndata.cpp
+        -r--r--r--   1 guilhem  lavaux      10866 Jan 24 16:41 config.cpp
+        -rw-rw-rw-   1 guilhem  lavaux      29967 Dec 21 19:17 cwlex_yy.c
+        -rw-rw-rw-   1 guilhem  lavaux      14342 Jan 22 19:51 cwy_tab.c
+        -r--r--r--   1 guilhem  lavaux      13890 Jan 29 19:18 date.cpp
+        -r--r--r--   1 guilhem  lavaux       3989 Feb  8 19:18 datstrm.cpp
+        @endverbatim
+

         But on Windows system, it will look like this:
         But on Windows system, it will look like this:

-        
-        Return value: @true if the file list was successfully retrieved, @false
-        otherwise.
-        
+
+        @verbatim
+        winamp~1 exe    520196 02-25-1999  19:28  winamp204.exe
+            1 file(s)           520 196 bytes
+        @endverbatim
+
+        @return @true if the file list was successfully retrieved, @false otherwise.
+

         @see GetFilesList()
     */
     bool GetDirList(wxArrayString& files,
         @see GetFilesList()
     */
     bool GetDirList(wxArrayString& files,


@@ -134,48 +158,56 @@ public:
 
     /**
         Returns the file size in bytes or -1 if the file doesn't exist or the size
 
     /**
         Returns the file size in bytes or -1 if the file doesn't exist or the size

-        couldn't be determined. Notice that this size can be approximative size only
-        and shouldn't be used for allocating the buffer in which the remote file is
-        copied, for example.
+        couldn't be determined.
+
+        Notice that this size can be approximative size only and shouldn't be used
+        for allocating the buffer in which the remote file is copied, for example.

     */
     int GetFileSize(const wxString& filename);
 
     /**
         This function returns the computer-parsable list of the files in the current
         directory (optionally only of the files matching the @e wildcard, all files
     */
     int GetFileSize(const wxString& filename);
 
     /**
         This function returns the computer-parsable list of the files in the current
         directory (optionally only of the files matching the @e wildcard, all files

-        by default). This list always has the same format and contains one full
-        (including the directory path) file name per line.
-        Return value: @true if the file list was successfully retrieved, @false
-        otherwise.
+        by default).
+
+        This list always has the same format and contains one full (including the
+        directory path) file name per line.
+
+        @returns @true if the file list was successfully retrieved, @false otherwise.
+
+        @see GetDirList()

     */
     bool GetFilesList(wxArrayString& files,
                       const wxString& wildcard = "");
 
     /**
     */
     bool GetFilesList(wxArrayString& files,
                       const wxString& wildcard = "");
 
     /**

-        Creates a new input stream on the specified path. You can use all but the seek
-        functionality of wxStream. Seek isn't available on all streams. For example,
-        HTTP or FTP streams do not deal with it. Other functions like Tell
-        are not available for this sort of stream, at present.
+        Creates a new input stream on the specified path.
+
+        You can use all but the seek functionality of wxStreamBase.
+        wxStreamBase::Seek() isn't available on all streams. For example, HTTP or FTP
+        streams do not deal with it. Other functions like wxStreamBase::Tell() are
+        not available for this sort of stream, at present.
+

         You will be notified when the EOF is reached by an error.
         You will be notified when the EOF is reached by an error.

-        
+

         @returns Returns @NULL if an error occurred (it could be a network failure
                  or the fact that the file doesn't exist).
     */
     wxInputStream* GetInputStream(const wxString& path);
 
     /**
         @returns Returns @NULL if an error occurred (it could be a network failure
                  or the fact that the file doesn't exist).
     */
     wxInputStream* GetInputStream(const wxString& path);
 
     /**

-        Returns the last command result, i.e. the full server reply for the last
-        command.
+        Returns the last command result, i.e. the full server reply for the last command.

     */
     const wxString GetLastResult();
 
     /**
     */
     const wxString GetLastResult();
 
     /**

-        Initializes an output stream to the specified @e file. The returned
-        stream has all but the seek functionality of wxStreams. When the user finishes
-        writing data, he has to delete the stream to close it.
-        
+        Initializes an output stream to the specified @e file.
+
+        The returned stream has all but the seek functionality of wxStreams.
+        When the user finishes writing data, he has to delete the stream to close it.
+

         @returns An initialized write-only stream.
         @returns An initialized write-only stream.

-        
+

         @see wxOutputStream
     */
     wxOutputStream* GetOutputStream(const wxString& file);
         @see wxOutputStream
     */
     wxOutputStream* GetOutputStream(const wxString& file);


@@ -224,10 +256,11 @@ public:
     bool SetBinary();
 
     /**
     bool SetBinary();
 
     /**

-        If @a pasv is @true, passive connection to the FTP server is used. This is
-        the default as it works with practically all firewalls. If the server doesn't
-        support passive move, you may call this function with @false argument to use
-        active connection.
+        If @a pasv is @true, passive connection to the FTP server is used.
+
+        This is the default as it works with practically all firewalls.
+        If the server doesn't support passive move, you may call this function with
+        @false argument to use active connection.

     */
     void SetPassive(bool pasv);
 
     */
     void SetPassive(bool pasv);
 


@@ -239,6 +272,7 @@ public:
     /**
         Sets the transfer mode to the specified one. It will be used for the next
         transfer.
     /**
         Sets the transfer mode to the specified one. It will be used for the next
         transfer.

+

         If this function is never called, binary transfer mode is used by default.
     */
     bool SetTransferMode(TransferMode mode);
         If this function is never called, binary transfer mode is used by default.
     */
     bool SetTransferMode(TransferMode mode);

diff --git a/interface/protocol/http.h b/interface/protocol/http.h
index 9ea510b233cb83ad0ab94de1f93e7401a00cbece..30e5c1e43501d9ce93bd4229eadced8ba82632f9 100644 (file)
--- a/interface/protocol/http.h
+++ b/interface/protocol/http.h
@@ -10,6 +10,7 @@
     @class wxHTTP
     @headerfile http.h wx/protocol/http.h
 
     @class wxHTTP
     @headerfile http.h wx/protocol/http.h
 

+    wxHTTP can be used to establish a connection to an HTTP server.

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


@@ -21,43 +22,50 @@ class wxHTTP : public wxProtocol
 public:
     /**
         Returns the data attached with a field whose name is specified by @e header.
 public:
     /**
         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.
+        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);
 
     /**

-        Creates a new input stream on the specified path. Notice that this stream is
-        unseekable, i.e. SeekI() and TellI() methods shouldn't be used.
+        Creates a new input stream on the specified path.
+
+        Notice that this stream is unseekable, i.e. SeekI() and TellI() methods
+        shouldn't be used.
+

         Note that you can still know the size of the file you are getting using
         Note that you can still know the size of the file you are getting using

-        wxStreamBase::GetSize. However there is a
-        limitation: in HTTP protocol, the size is not always specified so sometimes
-        @c (size_t)-1 can returned ot indicate that the size is unknown. In such
-        case, you may want to use wxInputStream::LastRead
-        method in a loop to get the total size.
-        
-        @returns Returns the initialized stream. You must delete it yourself once
-                 you don't use it anymore and this must be done before
+        wxStreamBase::GetSize(). However there is a limitation: in HTTP protocol,
+        the size is not always specified so sometimes @c (size_t)-1 can returned to
+        indicate that the size is unknown.
+        In such case, you may want to use wxInputStream::LastRead() method in a loop
+        to get the total size.
+
+        @returns Returns the initialized stream. You must delete it yourself
+                 once you don't use it anymore and this must be done before

                  the wxHTTP object itself is destroyed. The destructor
                  closes the network connection. The next time you will
                  try to get a file the network connection will have to
                  be reestablished, but you don't have to take care of
                  this since wxHTTP reestablishes it automatically.
                  the wxHTTP object itself is destroyed. The destructor
                  closes the network connection. The next time you will
                  try to get a file the network connection will have to
                  be reestablished, but you don't have to take care of
                  this since wxHTTP reestablishes it automatically.

-        
+

         @see wxInputStream
     */
     wxInputStream* GetInputStream(const wxString& path);
 
     /**
         @see wxInputStream
     */
     wxInputStream* GetInputStream(const wxString& path);
 
     /**

-        Returns the HTTP response code returned by the server. Please refer to
-        RFC 2616 for the list of responses.
+        Returns the HTTP response code returned by the server.
+
+        Please refer to RFC 2616 for the list of responses.

     */
     int GetResponse() const;
 
     /**
         It sets data of a field to be sent during the next request to the HTTP server.
     */
     int GetResponse() const;
 
     /**
         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 @e 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);
         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);

diff --git a/interface/protocol/protocol.h b/interface/protocol/protocol.h
index 43e6d9842ac2cee84b33c1285cadafc103f7ab47..185bdd58ce9694ae005276012bdfdaadf18fa09b 100644 (file)
--- a/interface/protocol/protocol.h
+++ b/interface/protocol/protocol.h
@@ -6,13 +6,31 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    Error values returned by wxProtocol.
+*/
+enum wxProtocolError
+{
+    wxPROTO_NOERR = 0,          //!< No error.
+    wxPROTO_NETERR,             //!< A generic network error occurred.
+    wxPROTO_PROTERR,            //!< An error occurred during negotiation.
+    wxPROTO_CONNERR,            //!< The client failed to connect the server.
+    wxPROTO_INVVAL,             //!< Invalid value.
+    wxPROTO_NOHNDLR,            //!< Not currently used.
+    wxPROTO_NOFILE,             //!< The remote file doesn't exist.
+    wxPROTO_ABRT,               //!< Last action aborted.
+    wxPROTO_RCNCT,              //!< An error occurred during reconnection.
+    wxPROTO_STREAMING           //!< Someone tried to send a command during a transfer.
+};
+

 /**
     @class wxProtocol
     @headerfile protocol.h wx/protocol/protocol.h
 
 /**
     @class wxProtocol
     @headerfile protocol.h wx/protocol/protocol.h
 

+    Represents a protocol for use with wxURL.

 
     @library{wxnet}
 
     @library{wxnet}

-    @category{FIXME}
+    @category{net}

 
     @see wxSocketBase, wxURL
 */
 
     @see wxSocketBase, wxURL
 */


@@ -21,7 +39,11 @@ class wxProtocol : public wxSocketClient
 public:
     /**
         Abort the current stream.
 public:
     /**
         Abort the current stream.

-        
+
+        @warning
+        It is advised to destroy the input stream instead of aborting the stream
+        this way.
+

         @returns Returns @true, if successful, else @false.
     */
     bool Abort();
         @returns Returns @true, if successful, else @false.
     */
     bool Abort();


@@ -33,60 +55,24 @@ public:
 
     /**
         Returns the last occurred error.
 
     /**
         Returns the last occurred error.

-        
-        @b wxPROTO_NOERR
-        
-        No error.
-        
-        @b wxPROTO_NETERR
-        
-        A generic network error occurred.
-        
-        @b wxPROTO_PROTERR
-        
-        An error occurred during negotiation.
-        
-        @b wxPROTO_CONNERR
-        
-        The client failed to connect the server.
-        
-        @b wxPROTO_INVVAL
-        
-        Invalid value.
-        
-        @b wxPROTO_NOHNDLR
-        
-        .
-        
-        @b wxPROTO_NOFILE
-        
-        The remote file doesn't exist.
-        
-        @b wxPROTO_ABRT
-        
-        Last action aborted.
-        
-        @b wxPROTO_RCNCT
-        
-        An error occurred during reconnection.
-        
-        @b wxPROTO_STREAM
-        
-        Someone tried to send a command during a transfer.
+
+        @see wxProtocolError

     */
     wxProtocolError GetError();
 
     /**
     */
     wxProtocolError GetError();
 
     /**

-        Creates a new input stream on the specified path. You can use all but seek
-        functionality of wxStream. Seek isn't available on all streams. For example,
-        HTTP or FTP streams don't deal with it. Other functions like StreamSize and
-        Tell aren't available for the moment for this sort of stream.
+        Creates a new input stream on the specified path.
+
+        You can use all but seek() functionality of wxStream.
+        Seek() isn't available on all streams. For example, HTTP or FTP streams
+        don't deal with it. Other functions like StreamSize() and Tell() aren't
+        available for the moment for this sort of stream.

         You will be notified when the EOF is reached by an error.
         You will be notified when the EOF is reached by an error.

-        
+

         @returns Returns the initialized stream. You will have to delete it
                  yourself once you don't use it anymore. The destructor
                  closes the network connection.
         @returns Returns the initialized stream. You will have to delete it
                  yourself once you don't use it anymore. The destructor
                  closes the network connection.

-        
+

         @see wxInputStream
     */
     wxInputStream* GetInputStream(const wxString& path);
         @see wxInputStream
     */
     wxInputStream* GetInputStream(const wxString& path);


@@ -94,7 +80,7 @@ public:
     /**
         Tries to reestablish a previous opened connection (close and renegotiate
         connection).
     /**
         Tries to reestablish a previous opened connection (close and renegotiate
         connection).

-        
+

         @returns @true, if the connection is established, else @false.
     */
     bool Reconnect();
         @returns @true, if the connection is established, else @false.
     */
     bool Reconnect();