interface/sckstrm.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        sckstrm.h
   3 // Purpose:     documentation for wxSocketOutputStream class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxSocketOutputStream
  11     @wxheader{sckstrm.h}
  12
  13     This class implements an output stream which writes data from
  14     a connected socket. Note that this stream is purely sequential
  15     and it does not support seeking.
  16
  17     @library{wxnet}
  18     @category{streams}
  19
  20     @seealso
  21     wxSocketBase
  22 */
  23 class wxSocketOutputStream : public wxOutputStream
  24 {
  25 public:
  26     /**
  27         Creates a new write-only socket stream using the specified initialized
  28         socket connection.
  29     */
  30     wxSocketOutputStream(wxSocketBase& s);
  31 };
  32
  33
  34 /**
  35     @class wxSocketInputStream
  36     @wxheader{sckstrm.h}
  37
  38     This class implements an input stream which reads data from
  39     a connected socket. Note that this stream is purely sequential
  40     and it does not support seeking.
  41
  42     @library{wxnet}
  43     @category{streams}
  44
  45     @seealso
  46     wxSocketBase
  47 */
  48 class wxSocketInputStream : public wxInputStream
  49 {
  50 public:
  51     /**
  52         Creates a new read-only socket stream using the specified initialized
  53         socket connection.
  54     */
  55     wxSocketInputStream(wxSocketBase& s);
  56 };