X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d984207cc37ad70649b2392314fb9e42719506c3..58f1fdc926e4fc0f0b8ca49384d72e51bea2e86b:/docs/latex/wx/strmsock.tex diff --git a/docs/latex/wx/strmsock.tex b/docs/latex/wx/strmsock.tex index e2d26c223d..2164ba7913 100644 --- a/docs/latex/wx/strmsock.tex +++ b/docs/latex/wx/strmsock.tex @@ -1,11 +1,26 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: socket.tex +%% Purpose: wxSocket docs +%% Author: Guillermo Rodriguez Garcia +%% 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{wxInputStream}{wxinputstream} \wxheading{Include files} @@ -13,25 +28,29 @@ \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase} +\helpref{wxSocketBase}{wxsocketbase} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSocketInputStream::wxSocketInputStream} +\membersection{wxSocketInputStream::wxSocketInputStream}\label{wxsocketinputstreamctor} \func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}} -Initializes a new read-only socket stream using the specified initialized -socket connection. +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{wxOutputStream}{wxoutputstream} \wxheading{Include files} @@ -39,14 +58,14 @@ socket connection. \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxSocketBase}{wxsocketbase} +\helpref{wxSocketBase}{wxsocketbase} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSocketOutputStream::wxSocketOutputStream} +\membersection{wxSocketOutputStream::wxSocketOutputStream}\label{wxsocketoutputstreamctor} -\func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}} +\func{}{wxSocketOutputStream}{\param{wxSocketBase\&}{ s}} -Initializes a new write-only socket stream using the specified initialized +Creates a new write-only socket stream using the specified initialized socket connection.