projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 7d2946d2 GL |
1 | \section{\class{wxProtocol}}\label{wxprotocol} |
| 2 | ||
| 3 | \wxheading{Derived from} | |
| 4 | ||
| 5 | \helpref{wxSocketClient}{wxsocketclient} | |
| 6 | ||
| 7 | \wxheading{See also} | |
| 8 | ||
| 9 | \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl} | |
| 10 | ||
| 11 | % ---------------------------------------------------------------------------- | |
| 12 | % Members | |
| 13 | % ---------------------------------------------------------------------------- | |
| 14 | ||
| 15 | \latexignore{\rtfignore{\membersection{Members}}} | |
| 16 | ||
| 17 | \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect} | |
| 18 | ||
| 19 | \func{bool}{Reconnect}{\void} | |
| 20 | ||
| 21 | Tries to reestablish a previous opened connection (close and renegotiate connection). | |
| 22 | ||
| 23 | \wxheading{Return value} | |
| 24 | ||
| 25 | TRUE, if the connection is established, else FALSE. | |
| 26 | ||
| 27 | % ---------------------------------------------------------------------------- | |
| 28 | ||
| 29 | \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput} | |
| 30 | ||
| 31 | \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}} | |
| 32 | ||
| 33 | Creates a new input stream on the the specified path. You can use all but seek | |
| 34 | functionnality of wxStream. Seek isn't available on all stream. For example, | |
| 35 | http or ftp streams doesn't deal with it. | |
| 36 | ||
| 37 | \wxheading{Return value} | |
| 38 | ||
| 39 | Returns the initialized stream. You will have to delete it yourself. | |
| 40 | ||
| 41 | % ---------------------------------------------------------------------------- | |
| 42 | ||
| 43 | \membersection{wxProtocol::Abort}\label{wxprotoabort} | |
| 44 | ||
| 45 | \func{bool }{Abort}{\void} | |
| 46 | ||
| 47 | Abort the current stream. | |
| 48 | \it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.} | |
| 49 | ||
| 50 | \wxheading{Return value} | |
| 51 | ||
| 52 | Returns TRUE, if successful, else FALSE. | |
| 53 | ||
| 54 | % ---------------------------------------------------------------------------- | |
| 55 | ||
| 56 | \membersection{wxProtocol::GetError} | |
| 57 | ||
| 58 | \func{wxProtocolError }{GetError}{\void} | |
| 59 | ||
| 60 | Returns the last occured error. | |
| 61 | ||
| 62 | % ---------------------------------------------------------------------------- | |
| 63 | ||
| 64 | \membersection{wxProtocol::GetContentType} | |
| 65 | ||
| 66 | \func{wxString }{GetContentType}{\void} | |
| 67 | ||
| 68 | Returns the type of the content of the last opened stream. It is a mime-type. | |
| 69 | ||
| 70 | % ---------------------------------------------------------------------------- | |
| 71 | ||
| 72 | \membersection{wxProtocol::SetUser} | |
| 73 | ||
| 74 | \func{void }{SetUser}{\param{const wxString\&}{ user}} | |
| 75 | ||
| 76 | Sets the authentication user. It is mainly useful when FTP is used. | |
| 77 | ||
| 78 | \membersection{wxProtocol::SetPassword} | |
| 79 | ||
| 80 | \func{void }{SetPassword}{\param{const wxString\&}{ user}} | |
| 81 | ||
| 82 | Sets the authentication password. It is mainly useful when FTP is used. |