docs/latex/wx/dgramsocket.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        dgramsocket.tex
   3 %% Purpose:     wxSocket docs
   4 %% Author:      Angel Vidal Veiga (kry@amule.org)
   5 %% Modified by:
   6 %% Created:     2006
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 % ---------------------------------------------------------------------------
  13 % CLASS wxDatagramSocket
  14 % ---------------------------------------------------------------------------
  15
  16 \section{\class{wxDatagramSocket}}\label{wxdatagramsocket}
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxSocketBase}{wxsocketbase}
  21
  22 \wxheading{Include files}
  23
  24 <wx/socket.h>
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28 % ---------------------------------------------------------------------------
  29 % Members
  30 % ---------------------------------------------------------------------------
  31 %
  32 % wxDatagramSocket
  33 %
  34 \membersection{wxDatagramSocket::wxDatagramSocket}\label{wxdatagramsocketctor}
  35
  36 \func{}{wxDatagramSocket}{\param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}
  37
  38 Constructor.
  39
  40 \wxheading{Parameters}
  41
  42 \docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
  43
  44 %
  45 % ~wxDatagramSocket
  46 %
  47 \membersection{wxDatagramSocket::\destruct{wxDatagramSocket}}\label{wxdatagramsocketdtor}
  48
  49 \func{}{\destruct{wxDatagramSocket}}{\void}
  50
  51 Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.
  52
  53 %
  54 % ReceiveFrom
  55 %
  56 \membersection{wxDatagramSocket::ReceiveFrom}\label{wxdatagramsocketreceivefrom}
  57
  58 \func{wxDatagramSocket\&}{ReceiveFrom}{\param{wxSockAddress\&}{ address}, \param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
  59
  60 This function reads a buffer of {\it nbytes} bytes from the socket.
  61
  62 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
  63
  64 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
  65
  66 \wxheading{Parameters}
  67
  68 \docparam{address}{Any address - will be overwritten with the address of the peer that sent that data.}
  69
  70 \docparam{buffer}{Buffer where to put read data.}
  71
  72 \docparam{nbytes}{Number of bytes.}
  73
  74 \wxheading{Return value}
  75
  76 Returns a reference to the current object, and the address of the peer that sent the data on address param.
  77
  78 \wxheading{See also}
  79
  80 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
  81 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
  82 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
  83 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
  84
  85 %
  86 % SendTo
  87 %
  88 \membersection{wxDatagramSocket::SendTo}\label{wxdatagramsocketsendto}
  89
  90 \func{wxDatagramSocket\&}{SendTo}{\param{const wxSockAddress\&}{ address}, \param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
  91
  92 This function writes a buffer of {\it nbytes} bytes to the socket.
  93
  94 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually wrote.
  95
  96 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
  97
  98 \wxheading{Parameters}
  99
 100 \docparam{address}{The address of the destination peer for this data.}
 101
 102 \docparam{buffer}{Buffer where read data is.}
 103
 104 \docparam{nbytes}{Number of bytes.}
 105
 106 \wxheading{Return value}
 107
 108 Returns a reference to the current object.
 109
 110 \wxheading{See also}
 111
 112 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
 113 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
 114 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
 115 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
 116