git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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	\helpref{wxObject}{wxobject}
	22
	23	\wxheading{Include files}
	24
	25	<wx/socket.h>
	26
	27	\wxheading{Library}
	28
	29	\helpref{wxNet}{librarieslist}
	30
	31	\latexignore{\rtfignore{\wxheading{Members}}}
	32
	33	% ---------------------------------------------------------------------------
	34	% Members
	35	% ---------------------------------------------------------------------------
	36	%
	37	% wxDatagramSocket
	38	%
	39	\membersection{wxDatagramSocket::wxDatagramSocket}\label{wxdatagramsocketctor}
	40
	41	\func{}{wxDatagramSocket}{\param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}
	42
	43	Constructor.
	44
	45	\wxheading{Parameters}
	46
	47	\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
	48
	49	%
	50	% ~wxDatagramSocket
	51	%
	52	\membersection{wxDatagramSocket::\destruct{wxDatagramSocket}}\label{wxdatagramsocketdtor}
	53
	54	\func{}{\destruct{wxDatagramSocket}}{\void}
	55
	56	Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.
	57
	58	%
	59	% ReceiveFrom
	60	%
	61	\membersection{wxDatagramSocket::ReceiveFrom}\label{wxdatagramsocketreceivefrom}
	62
	63	\func{wxDatagramSocket\&}{ReceiveFrom}{\param{wxSockAddress\&}{ address}, \param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
	64
	65	This function reads a buffer of {\it nbytes} bytes from the socket.
	66
	67	Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
	68
	69	Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
	70
	71	\wxheading{Parameters}
	72
	73	\docparam{address}{Any address - will be overwritten with the address of the peer that sent that data.}
	74
	75	\docparam{buffer}{Buffer where to put read data.}
	76
	77	\docparam{nbytes}{Number of bytes.}
	78
	79	\wxheading{Return value}
	80
	81	Returns a reference to the current object, and the address of the peer that sent the data on address param.
	82
	83	\wxheading{See also}
	84
	85	\helpref{wxSocketBase::Error}{wxsocketbaseerror},
	86	\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
	87	\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
	88	\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
	89
	90	%
	91	% SendTo
	92	%
	93	\membersection{wxDatagramSocket::SendTo}\label{wxdatagramsocketsendto}
	94
	95	\func{wxDatagramSocket\&}{SendTo}{\param{const wxSockAddress\&}{ address}, \param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
	96
	97	This function writes a buffer of {\it nbytes} bytes to the socket.
	98
	99	Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually wrote.
	100
	101	Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
	102
	103	\wxheading{Parameters}
	104
	105	\docparam{address}{The address of the destination peer for this data.}
	106
	107	\docparam{buffer}{Buffer where read data is.}
	108
	109	\docparam{nbytes}{Number of bytes.}
	110
	111	\wxheading{Return value}
	112
	113	Returns a reference to the current object.
	114
	115	\wxheading{See also}
	116
	117	\helpref{wxSocketBase::Error}{wxsocketbaseerror},
	118	\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
	119	\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
	120	\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
	121