Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53118 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-04-10 21:31:05 +00:00
parent c427b5e3d4
commit a30b5ab969
3 changed files with 136 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
interface/protocol/ftp.h
View File

@@ -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 @class wxFTP
@headerfile ftp.h wx/protocol/ftp.h @headerfile ftp.h wx/protocol/ftp.h
@@ -14,11 +24,11 @@
usual operations. Please consult the RFC 959 for more details about the FTP usual operations. Please consult the RFC 959 for more details about the FTP
protocol. 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 generic wxFTP::SendCommand() method.
transfer files you just get or give a stream to or from this class and the However to actually transfer files you just get or give a stream to or from this
actual data are read or written using the usual stream methods. class and the actual data are read or written using the usual stream methods.
Example of using wxFTP for file downloading: Example of using wxFTP for file downloading:
@@ -45,7 +55,7 @@
{ {
size_t size = in-GetSize(); size_t size = in-GetSize();
char *data = new char[size]; char *data = new char[size];
if ( !in-Read(data, size) ) if ( !in->Read(data, size) )
{ {
wxLogError("Read error"); wxLogError("Read error");
} }
@@ -67,7 +77,7 @@
wxOutputStream *out = ftp.GetOutputStream("filename"); wxOutputStream *out = ftp.GetOutputStream("filename");
if ( out ) if ( out )
{ {
out-Write(...); // your data out->Write(...); // your data
delete out; delete out;
} }
@endcode @endcode
@@ -116,16 +126,30 @@ 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. 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, 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: 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 @verbatim
otherwise. 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() @see GetFilesList()
*/ */
@@ -134,28 +158,36 @@ 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 couldn't be determined.
and shouldn't be used for allocating the buffer in which the remote file is
copied, for example. 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); int GetFileSize(const wxString& filename);
/** /**
This function returns the computer-parsable list of the files in the current 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 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 by default).
(including the directory path) file name per line.
Return value: @true if the file list was successfully retrieved, @false This list always has the same format and contains one full (including the
otherwise. directory path) file name per line.
@returns @true if the file list was successfully retrieved, @false otherwise.
@see GetDirList()
*/ */
bool GetFilesList(wxArrayString& files, bool GetFilesList(wxArrayString& files,
const wxString& wildcard = ""); const wxString& wildcard = "");
/** /**
Creates a new input stream on the specified path. You can use all but the seek Creates a new input stream on the specified path.
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 You can use all but the seek functionality of wxStreamBase.
are not available for this sort of stream, at present. 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 @returns Returns @NULL if an error occurred (it could be a network failure
@@ -164,15 +196,15 @@ public:
wxInputStream* GetInputStream(const wxString& path); wxInputStream* GetInputStream(const wxString& path);
/** /**
Returns the last command result, i.e. the full server reply for the last Returns the last command result, i.e. the full server reply for the last command.
command.
*/ */
const wxString GetLastResult(); const wxString GetLastResult();
/** /**
Initializes an output stream to the specified @e file. The returned Initializes an output stream to the specified @e file.
stream has all but the seek functionality of wxStreams. When the user finishes
writing data, he has to delete the stream to close it. 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.
@@ -224,10 +256,11 @@ public:
bool SetBinary(); bool SetBinary();
/** /**
If @a pasv is @true, passive connection to the FTP server is used. This is If @a pasv is @true, passive connection to the FTP server is used.
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 This is the default as it works with practically all firewalls.
active connection. 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 Sets the transfer mode to the specified one. It will be used for the next
transfer. transfer.
If this function is never called, binary transfer mode is used by default. If this function is never called, binary transfer mode is used by default.
*/ */
bool SetTransferMode(TransferMode mode); bool SetTransferMode(TransferMode mode);

40
interface/protocol/http.h
View File

@@ -10,6 +10,7 @@
@class wxHTTP @class wxHTTP
@headerfile http.h wx/protocol/http.h @headerfile http.h wx/protocol/http.h
wxHTTP can be used to establish a connection to an HTTP server.
@library{wxnet} @library{wxnet}
@category{net} @category{net}
@@ -21,23 +22,29 @@ class wxHTTP : public wxProtocol
public: public:
/** /**
Returns the data attached with a field whose name is specified by @e header. 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 If the field doesn't exist, it will return an empty string and not a @NULL string.
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 Creates a new input stream on the specified path.
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
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 Notice that this stream is unseekable, i.e. SeekI() and TellI() methods
you don't use it anymore and this must be done before shouldn't be used.
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 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 the wxHTTP object itself is destroyed. The destructor
closes the network connection. The next time you will closes the network connection. The next time you will
try to get a file the network connection will have to try to get a file the network connection will have to
@@ -49,15 +56,16 @@ public:
wxInputStream* GetInputStream(const wxString& path); wxInputStream* GetInputStream(const wxString& path);
/** /**
Returns the HTTP response code returned by the server. Please refer to Returns the HTTP response code returned by the server.
RFC 2616 for the list of responses.
Please refer to RFC 2616 for the list of responses.
*/ */
int GetResponse() const; int GetResponse() const;
/** /**
It sets data of a field to be sent during the next request to the HTTP server. 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. 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); void SetHeader(const wxString& header, const wxString& h_data);

74
interface/protocol/protocol.h
View File

@@ -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 @class wxProtocol
@headerfile protocol.h wx/protocol/protocol.h @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
*/ */
@@ -22,6 +40,10 @@ public:
/** /**
Abort the current stream. 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. @returns Returns @true, if successful, else @false.
*/ */
bool Abort(); bool Abort();
@@ -34,53 +56,17 @@ public:
/** /**
Returns the last occurred error. Returns the last occurred error.
@b wxPROTO_NOERR @see wxProtocolError
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.
*/ */
wxProtocolError GetError(); wxProtocolError GetError();
/** /**
Creates a new input stream on the specified path. You can use all but seek Creates a new input stream on the specified path.
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 You can use all but seek() functionality of wxStream.
Tell aren't available for the moment for this sort of stream. 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 @returns Returns the initialized stream. You will have to delete it