From 4d8b1e479121b861bc99830d2ebca248bc162468 Mon Sep 17 00:00:00 2001 From: Angel Vidal Veiga Date: Fri, 30 Jun 2006 17:32:56 +0000 Subject: [PATCH] Old socket code has no wxDatagramSocket::Connect() or DisconnecT(), removing from HEAD docs git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39907 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/dgramsocket.tex | 78 ----------------------------------- 1 file changed, 78 deletions(-) diff --git a/docs/latex/wx/dgramsocket.tex b/docs/latex/wx/dgramsocket.tex index f4b68f6ac0..0f66ac8e37 100644 --- a/docs/latex/wx/dgramsocket.tex +++ b/docs/latex/wx/dgramsocket.tex @@ -50,72 +50,6 @@ Constructor. Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}. -% -% Connect -% -\membersection{wxDatagramSocket::Connect}\label{wxdatagramsocketconnect} - -\func{bool}{Connect}{\param{wxSockAddress\&}{ address}} - -Connects to another peer using the specified address. - -Connecting in an UDP socket like the one wxDatagramSocket creates is different -from TCP socket's idea of connect. Give then fact that UDP is a connectionless -protocol, the meaning of wxDatagramSocket::Connect is that of the unix connect() -call when used with with UDP sockets. This means the socket send/receive will be bind -to the wxSockAddress specified, and no datagrams will be send or received from other -address. - -The Connect() call can be isued several times with no drawbacks, to change the destination -adddress. - -{\bf Warning:} When a Connect() has been called on a socket, calling \helpref{ReceiveFrom}{wxdatagramsocketreceivefrom} or \helpref{SendTo}{wxdatagramsocketsendto} with a different wxSockAddress will result in an assertion on debug mode and -no data being sent/received on both debug and release modes. Use -\helpref{Read()}{wxsocketbaseread} and \helpref{Write()}{wxsocketbasewrite} -after calling Connect() to make sure you're reading from/writing to the proper destination. - -\wxheading{Parameters} - -\docparam{address}{Address of the destination peer.} - -\wxheading{Return value} - -Returns true if the connect() call is successful and socket is correctly -attached to the destination address. - -\wxheading{See also} - -\helpref{wxDatagramSocket::Disconnect}{wxdatagramsocketdisconnect}, - -\newsince{2.7.0} { There was no way to Connect() an wxDatagramSocket before }. - -% -% Disconnect -% -\membersection{wxDatagramSocket::Disconnect}\label{wxdatagramsocketdisconnect} - -\func{bool}{Disconnect}{} - -Removes previously bind to an specific destination address set by a -\helpref{Connect()}{wxdatagramsocketconnect} call. - -The Disconnect() call can be isued several times with no drawbacks. No error is set -if the socket was not connected. - - -\wxheading{Parameters} - - -\wxheading{Return value} - -Returns true if the socket was sucessfully deatached from the destination address. - -\wxheading{See also} - -\helpref{wxDatagramSocket::Connect}{wxdatagramsocketconnect}, - -\newsince{2.7.0} { There was no way to Connect() an wxDatagramSocket before. } - % % ReceiveFrom % @@ -141,18 +75,12 @@ Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded. Returns a reference to the current object, and the address of the peer that sent the data on address param. -\wxheading{Remark/Warning} - -If a \helpref{Connect()}{wxdatagramsocketconnect} call is issued before ReceiveFrom is called, -the address sent on this call MUST match the one ussed on the Connect() call, or this call will assert. It's usually a good idea to use \helpref{wxSocketBase::Read}{wxsocketbaseread} in this case. - \wxheading{See also} \helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}, -\helpref{Connect()}{wxdatagramsocketconnect} % % SendTo @@ -179,15 +107,9 @@ Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded. Returns a reference to the current object. -\wxheading{Remark/Warning} - -If a \helpref{Connect()}{wxdatagramsocketconnect} call is issued before SendTo is called, -the address sent on this call MUST match the one ussed on the Connect() call, or this call will assert. It's usually a good idea to use \helpref{wxSocketBase::Write}{wxsocketbasewrite} in this case. - \wxheading{See also} \helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags} -\helpref{Connect()}{wxdatagramsocketconnect} -- 2.45.2