added vendor display name (for consistency with app display name &c) (patch 1831303)

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

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Name:        socket.tex
%% Purpose:     wxSocket docs
%% Author:      Guillermo Rodriguez Garcia <guille@iies.es>
%% Modified by:
%% Created:     1999
%% RCS-ID:      $Id$
%% Copyright:   (c) wxWidgets team
%% License:     wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% -----------------------------------------------------------------------------
% wxSocketInputStream
% -----------------------------------------------------------------------------
\section{\class{wxSocketInputStream}}\label{wxsocketinputstream}

This class implements an input stream which reads data from
a connected socket. Note that this stream is purely sequential
and it does not support seeking.

\wxheading{Derived from}

\helpref{wxInputStream}{wxinputstream}\\
\helpref{wxStreamBase}{wxstreambase}

\wxheading{Include files}

<wx/sckstrm.h>

\wxheading{Library}

\helpref{wxNet}{librarieslist}

\wxheading{See also}

\helpref{wxSocketBase}{wxsocketbase}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSocketInputStream::wxSocketInputStream}\label{wxsocketinputstreamctor}

\func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}

Creates a new read-only socket stream using the specified initialized
socket connection. 

% -----------------------------------------------------------------------------
% wxSocketOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxSocketOutputStream}}\label{wxsocketoutputstream}

This class implements an output stream which writes data from
a connected socket. Note that this stream is purely sequential
and it does not support seeking.

\wxheading{Derived from}

\helpref{wxOutputStream}{wxoutputstream}\\
\helpref{wxStreamBase}{wxstreambase}

\wxheading{Include files}

<wx/sckstrm.h>

\wxheading{Library}

\helpref{wxNet}{librarieslist}

\wxheading{See also}

\helpref{wxSocketBase}{wxsocketbase}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSocketOutputStream::wxSocketOutputStream}\label{wxsocketoutputstreamctor}

\func{}{wxSocketOutputStream}{\param{wxSocketBase\&}{ s}}

Creates a new write-only socket stream using the specified initialized
socket connection.