latex/wx/socket.tex

12 \section{\class{wxSocketBase}}\label{wxsocketbase}
14 wxSocketBase is the base class for all socket-related objects, and it
19 call wxSocketBase::Initialize() (undocumented) from the main thread before creating
114 \helpref{wxSocketBase}{wxsocketbaseconstruct}\\
115 \helpref{\destruct{wxSocketBase}}{wxsocketbasedestruct}\\
188 \membersection{wxSocketBase::wxSocketBase}\label{wxsocketbaseconstruct}
190 \func{}{wxSocketBase}{\void}
196 \membersection{wxSocketBase::\destruct{wxSocketBase}}\label{wxsocketbasedestruct}
198 \func{}{\destruct{wxSocketBase}}{\void}
208 \membersection{wxSocketBase::Close}\label{wxsocketbaseclose}
229 \membersection{wxSocketBase::Destroy}\label{wxsocketbasedestroy}
249 \membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
251 \func{wxSocketBase\&}{Discard}{\void}
263 \membersection{wxSocketBase::Error}\label{wxsocketbaseerror}
275 \membersection{wxSocketBase::GetClientData}\label{wxsocketbasegetclientdata}
285 \membersection{wxSocketBase::GetLocal}\label{wxsocketbasegetlocal}
300 \membersection{wxSocketBase::GetFlags}\label{wxsocketbasegetflags}
309 \membersection{wxSocketBase::GetPeer}\label{wxsocketbasegetpeer}
324 \membersection{wxSocketBase::InterruptWait}\label{wxsocketbaseinterruptwait}
336 \helpref{wxSocketBase::Wait}{wxsocketbasewait},
338 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
339 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
340 \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
346 \membersection{wxSocketBase::IsConnected}\label{wxsocketbaseisconnected}
355 \membersection{wxSocketBase::IsData}\label{wxsocketbaseisdata}
365 \membersection{wxSocketBase::IsDisconnected}\label{wxsocketbaseisdisconnected}
374 \membersection{wxSocketBase::LastCount}\label{wxsocketbaselastcount}
390 \membersection{wxSocketBase::LastError}\label{wxsocketbaselasterror}
406 \membersection{wxSocketBase::Notify}\label{wxsocketbasenotify}
419 \membersection{wxSocketBase::IsOk}\label{wxsocketbaseisok}
441 \membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
452 \helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
457 \membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
471 \helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
476 \membersection{wxSocketBase::SetClientData}\label{wxsocketbasesetclientdata}
487 \membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
504 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
505 \helpref{wxSocketBase::Notify}{wxsocketbasenotify},
512 \membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
590 \membersection{wxSocketBase::SetLocal}\label{wxsocketbasesetlocal}
602 \membersection{wxSocketBase::SetNotify}\label{wxsocketbasesetnotify}
633 \membersection{wxSocketBase::SetTimeout}\label{wxsocketbasesettimeout}
645 \membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
647 \func{wxSocketBase\&}{Peek}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
668 The exact behaviour of wxSocketBase::Peek depends on the combination
669 of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
673 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
674 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
675 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
676 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
681 \membersection{wxSocketBase::Read}\label{wxsocketbaseread}
683 \func{wxSocketBase\&}{Read}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
703 The exact behaviour of wxSocketBase::Read depends on the combination
704 of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
708 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
709 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
710 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
711 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
716 \membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
718 \func{wxSocketBase\&}{ReadMsg}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
741 wxSocketBase::ReadMsg will behave as if the {\bf wxSOCKET\_WAITALL} flag
744 For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
748 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
749 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
750 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
751 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
752 \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
757 \membersection{wxSocketBase::Unread}\label{wxsocketbaseunread}
759 \func{wxSocketBase\&}{Unread}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
780 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
781 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
782 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
787 \membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
819 \helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
821 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
822 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
823 \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
829 \membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
850 \helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
851 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
856 \membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
880 \helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
881 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
886 \membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
910 \helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
911 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
916 \membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
918 \func{wxSocketBase\&}{Write}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
938 The exact behaviour of wxSocketBase::Write depends on the combination
939 of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
943 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
944 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
945 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
946 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
951 \membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
953 \func{wxSocketBase\&}{WriteMsg}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
977 wxSocketBase::WriteMsg will behave as if the {\bf wxSOCKET\_WAITALL} flag
980 For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
984 \helpref{wxSocketBase::Error}{wxsocketbaseerror},
985 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
986 \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
987 \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
988 \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
999 \helpref{wxSocketBase}{wxsocketbase}
1021 \docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
1030 Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.
1079 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
1080 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}
1130 \helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
1131 \helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
1160 \helpref{wxSocketBase}{wxsocketbase},
1177 set with \helpref{wxSocketBase::SetClientData}{wxsocketbasesetclientdata}.
1181 \constfunc{wxSocketBase *}{GetSocket}{\void}