| 1 | \section{\class{wxProtocol}}\label{wxprotocol} |
| 2 | |
| 3 | \wxheading{Derived from} |
| 4 | |
| 5 | \helpref{wxSocketClient}{wxsocketclient} |
| 6 | |
| 7 | \wxheading{Include files} |
| 8 | |
| 9 | <wx/protocol/protocol.h> |
| 10 | |
| 11 | \wxheading{See also} |
| 12 | |
| 13 | \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} |
| 14 | |
| 15 | % ---------------------------------------------------------------------------- |
| 16 | % Members |
| 17 | % ---------------------------------------------------------------------------- |
| 18 | |
| 19 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 20 | |
| 21 | \membersection{wxProtocol::Reconnect}\label{wxprotocolreconnect} |
| 22 | |
| 23 | \func{bool}{Reconnect}{\void} |
| 24 | |
| 25 | Tries to reestablish a previous opened connection (close and renegotiate connection). |
| 26 | |
| 27 | \wxheading{Return value} |
| 28 | |
| 29 | true, if the connection is established, else false. |
| 30 | |
| 31 | % ---------------------------------------------------------------------------- |
| 32 | \membersection{wxProtocol::GetInputStream}\label{wxprotocolgetinput} |
| 33 | |
| 34 | \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} |
| 35 | |
| 36 | Creates a new input stream on the specified path. You can use all but seek |
| 37 | functionality of wxStream. Seek isn't available on all streams. For example, |
| 38 | HTTP or FTP streams don't deal with it. Other functions like StreamSize and |
| 39 | Tell aren't available for the moment for this sort of stream. |
| 40 | You will be notified when the EOF is reached by an error. |
| 41 | |
| 42 | \wxheading{Return value} |
| 43 | |
| 44 | Returns the initialized stream. You will have to delete it yourself once you |
| 45 | don't use it anymore. The destructor closes the network connection. |
| 46 | |
| 47 | \wxheading{See also} |
| 48 | |
| 49 | \helpref{wxInputStream}{wxinputstream} |
| 50 | |
| 51 | % ---------------------------------------------------------------------------- |
| 52 | \membersection{wxProtocol::Abort}\label{wxprotocolabort} |
| 53 | |
| 54 | \func{bool}{Abort}{\void} |
| 55 | |
| 56 | Abort the current stream. |
| 57 | |
| 58 | \wxheading{Warning} |
| 59 | |
| 60 | It is advised to destroy the input stream instead of aborting the stream this way. |
| 61 | |
| 62 | \wxheading{Return value} |
| 63 | |
| 64 | Returns true, if successful, else false. |
| 65 | |
| 66 | % ---------------------------------------------------------------------------- |
| 67 | \membersection{wxProtocol::GetError}\label{wxprotocolgeterror} |
| 68 | |
| 69 | \func{wxProtocolError}{GetError}{\void} |
| 70 | |
| 71 | Returns the last occurred error. |
| 72 | |
| 73 | \twocolwidtha{7cm} |
| 74 | \begin{twocollist}\itemsep=0pt |
| 75 | \twocolitem{{\bf wxPROTO\_NOERR}}{No error.} |
| 76 | \twocolitem{{\bf wxPROTO\_NETERR}}{A generic network error occurred.} |
| 77 | \twocolitem{{\bf wxPROTO\_PROTERR}}{An error occurred during negotiation.} |
| 78 | \twocolitem{{\bf wxPROTO\_CONNERR}}{The client failed to connect the server.} |
| 79 | \twocolitem{{\bf wxPROTO\_INVVAL}}{Invalid value.} |
| 80 | \twocolitem{{\bf wxPROTO\_NOHNDLR}}{.} |
| 81 | \twocolitem{{\bf wxPROTO\_NOFILE}}{The remote file doesn't exist.} |
| 82 | \twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.} |
| 83 | \twocolitem{{\bf wxPROTO\_RCNCT}}{An error occurred during reconnection.} |
| 84 | \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.} |
| 85 | \end{twocollist} |
| 86 | |
| 87 | % ---------------------------------------------------------------------------- |
| 88 | \membersection{wxProtocol::GetContentType}\label{wxprotocolgetcontenttype} |
| 89 | |
| 90 | \func{wxString}{GetContentType}{\void} |
| 91 | |
| 92 | Returns the type of the content of the last opened stream. It is a mime-type. |
| 93 | |
| 94 | % ---------------------------------------------------------------------------- |
| 95 | \membersection{wxProtocol::SetUser}\label{wxprotocolsetuser} |
| 96 | |
| 97 | \func{void }{SetUser}{\param{const wxString\&}{ user}} |
| 98 | |
| 99 | Sets the authentication user. It is mainly useful when FTP is used. |
| 100 | |
| 101 | \membersection{wxProtocol::SetPassword}\label{wxprotocolsetpassword} |
| 102 | |
| 103 | \func{void}{SetPassword}{\param{const wxString\&}{ user}} |
| 104 | |
| 105 | Sets the authentication password. It is mainly useful when FTP is used. |
| 106 | |