Please add classes in alphabetical order

[wxWidgets.git] / docs / latex / wx / protocol.tex

\section{\class{wxProtocol}}\label{wxprotocol}

\wxheading{Derived from}

\helpref{wxSocketClient}{wxsocketclient}

\wxheading{Include files}

<wx/protocol/protocol.h>

\wxheading{See also}

\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}

% ----------------------------------------------------------------------------
% Members
% ----------------------------------------------------------------------------

\latexignore{\rtfignore{\membersection{Members}}}

\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}

\func{bool}{Reconnect}{\void}

Tries to reestablish a previous opened connection (close and renegotiate connection).

\wxheading{Return value}

TRUE, if the connection is established, else FALSE.

% ----------------------------------------------------------------------------
\membersection{wxProtocol::GetInputStream}\label{wxprotogetinput}

\func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}

Creates a new input stream on the the specified path. You can use all but seek
functionnality of wxStream. Seek isn't available on all stream. For example,
http or ftp streams doesn'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.

\wxheading{Return value}

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

\wxheading{See also}

\helpref{wxInputStream}{wxinputstream}

% ----------------------------------------------------------------------------
\membersection{wxProtocol::Abort}\label{wxprotoabort}

\func{bool}{Abort}{\void}

Abort the current stream.

\wxheading{Warning}

It is advised to destroy the input stream instead of aborting the stream this way.

\wxheading{Return value}

Returns TRUE, if successful, else FALSE.

% ----------------------------------------------------------------------------
\membersection{wxProtocol::GetError}

\func{wxProtocolError}{GetError}{\void}

Returns the last occured error.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxPROTO\_NOERR}}{No error.}
\twocolitem{{\bf wxPROTO\_NETERR}}{A generic network error occured.}
\twocolitem{{\bf wxPROTO\_PROTERR}}{An error occured during negotiation.}
\twocolitem{{\bf wxPROTO\_CONNERR}}{The client failed to connect the server.}
\twocolitem{{\bf wxPROTO\_INVVAL}}{Invalid value.}
\twocolitem{{\bf wxPROTO\_NOHNDLR}}{.}
\twocolitem{{\bf wxPROTO\_NOFILE}}{The remote file doesn't exist.}
\twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.}
\twocolitem{{\bf wxPROTO\_RCNCT}}{An error occured during reconnection.}
\twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}
\end{twocollist}

% ----------------------------------------------------------------------------
\membersection{wxProtocol::GetContentType}

\func{wxString}{GetContentType}{\void}

Returns the type of the content of the last opened stream. It is a mime-type.

% ----------------------------------------------------------------------------
\membersection{wxProtocol::SetUser}

\func{void }{SetUser}{\param{const wxString\&}{ user}}

Sets the authentication user. It is mainly useful when FTP is used.

\membersection{wxProtocol::SetPassword}

\func{void}{SetPassword}{\param{const wxString\&}{ user}}

Sets the authentication password. It is mainly useful when FTP is used.