interface/protocol/protocol.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        protocol/protocol.h
   3 // Purpose:     interface of wxProtocol
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Error values returned by wxProtocol.
  11 */
  12 enum wxProtocolError
  13 {
  14     wxPROTO_NOERR = 0,          //!< No error.
  15     wxPROTO_NETERR,             //!< A generic network error occurred.
  16     wxPROTO_PROTERR,            //!< An error occurred during negotiation.
  17     wxPROTO_CONNERR,            //!< The client failed to connect the server.
  18     wxPROTO_INVVAL,             //!< Invalid value.
  19     wxPROTO_NOHNDLR,            //!< Not currently used.
  20     wxPROTO_NOFILE,             //!< The remote file doesn't exist.
  21     wxPROTO_ABRT,               //!< Last action aborted.
  22     wxPROTO_RCNCT,              //!< An error occurred during reconnection.
  23     wxPROTO_STREAMING           //!< Someone tried to send a command during a transfer.
  24 };
  25
  26 /**
  27     @class wxProtocol
  28     @headerfile protocol.h wx/protocol/protocol.h
  29
  30     Represents a protocol for use with wxURL.
  31
  32     @library{wxnet}
  33     @category{net}
  34
  35     @see wxSocketBase, wxURL
  36 */
  37 class wxProtocol : public wxSocketClient
  38 {
  39 public:
  40     /**
  41         Abort the current stream.
  42
  43         @warning
  44         It is advised to destroy the input stream instead of aborting the stream
  45         this way.
  46
  47         @returns Returns @true, if successful, else @false.
  48     */
  49     bool Abort();
  50
  51     /**
  52         Returns the type of the content of the last opened stream. It is a mime-type.
  53     */
  54     wxString GetContentType();
  55
  56     /**
  57         Returns the last occurred error.
  58
  59         @see wxProtocolError
  60     */
  61     wxProtocolError GetError();
  62
  63     /**
  64         Creates a new input stream on the specified path.
  65
  66         You can use all but seek() functionality of wxStream.
  67         Seek() isn't available on all streams. For example, HTTP or FTP streams
  68         don't deal with it. Other functions like StreamSize() and Tell() aren't
  69         available for the moment for this sort of stream.
  70         You will be notified when the EOF is reached by an error.
  71
  72         @returns Returns the initialized stream. You will have to delete it
  73                  yourself once you don't use it anymore. The destructor
  74                  closes the network connection.
  75
  76         @see wxInputStream
  77     */
  78     wxInputStream* GetInputStream(const wxString& path);
  79
  80     /**
  81         Tries to reestablish a previous opened connection (close and renegotiate
  82         connection).
  83
  84         @returns @true, if the connection is established, else @false.
  85     */
  86     bool Reconnect();
  87
  88     /**
  89         Sets the authentication password. It is mainly useful when FTP is used.
  90     */
  91     void SetPassword(const wxString& user);
  92
  93     /**
  94         Sets the authentication user. It is mainly useful when FTP is used.
  95     */
  96     void SetUser(const wxString& user);
  97 };
  98