latex/wx/socket.tex

17 Note: (Workaround for implementation limitation for wxWidgets up to 2.5.x)
18 If you want to use sockets or derived classes such as wxFTP in a secondary thread,
39 \twocolitem{{\bf wxSOCKET\_INVADDR}}{Invalid address passed to wxSocket.}
53 \twocolitem{{\bf wxSOCKET\_OUTPUT}}{The socket is ready to be written to.}
58 A brief note on how to use these events:
64 does not need to read all available data in response to a
74 can write data to the socket until an {\bf wxSOCKET\_WOULDBLOCK}
91 handler macro to direct events to member functions that take
120 Functions to retrieve current state and miscellaneous info.
160 Functions that allow applications to customize socket IO as needed.
169 Functions that allow applications to receive socket events.
193 \helpref{wxSocketClient}{wxsocketclient} to construct a socket client, or
194 \helpref{wxSocketServer}{wxsocketserver} to construct a socket server.
215 called, so in most cases you won't need to do it yourself, unless you
216 explicitly want to shut down the socket, typically to notify the peer
223 application must therefore be prepared to handle socket event messages
236 the wxSocket to a list of object to be deleted on idle time, after all
256 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually discarded.
269 Use this function to check for an error condition after one of the
328 Use this function to interrupt any wait operation currently in progress.
329 Note that this is not intended as a regular way to interrupt a Wait call,
331 absolutely necessary to use it, for example to abort an operation due to
334 socket destruction), so you don't need to use it in these cases.
383 Use this function to get the number of bytes actually transferred
397 but it should not be used to determine if an error has occurred (this
399 Use \helpref{Error}{wxsocketbaseerror} first, in order to determine
401 to discover the cause of the error.
410 According to the {\it notify} value, this function enables
413 be sent to the application. If {\it notify} is false; no events
429 the client is connected to a server.
432 server could bind to the specified address and is already listening for
448 Calls to SaveState and RestoreState can be nested.
467 Calls to SaveState and RestoreState can be nested.
481 contain a pointer to this data, which can be retrieved with
491 Sets an event handler to be called when a socket event occurs. The
498 \docparam{handler}{Specifies the event handler you want to use.}
516 Use SetFlags to customize IO operation for this socket.
524 \twocolitem{{\bf wxSOCKET\_WAITALL}}{Wait for all required data to be read/written unless an error occurs.}
529 A brief overview on how to use these flags follows.
534 exactly one blocking low-level call to recv() or send(). Note
535 that {\it blocking} here refers to when the function returns, not
536 to whether the GUI blocks during this time.
542 low-level call to recv() or send(). Note that {\it nonblocking} here
543 refers to when the function returns, not to whether the GUI blocks during
549 same as having a loop which makes as many blocking low-level calls to
550 recv() or send() as needed so as to transfer all the data. Note
551 that {\it blocking} here refers to when the function returns, not
552 to whether the GUI blocks during this time.
558 care to avoid unwanted reentrance.
561 setsockopt() flag. This flag allows the socket to bind to a port that is already in use.
562 This is mostly used on UNIX-based systems to allow rapid starting and stopping of a server -
563 otherwise you may have to wait several minutes for the port to become available.
564 wxSOCKET\_REUSEADDR can also be used with socket clients to (re)bind to a particular local port
568 use of wxSOCKET\_REUSEADDR implies SO\_REUSEPORT in addition to SO\_REUSEADDR to be consistent
573 {\bf wxSOCKET\_NONE} will try to read at least SOME data, no matter how much.
581 {\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
594 This function allows you to set the local address and port,
595 useful when an application needs to reuse a particular port. When
606 SetNotify specifies which socket events are to be sent to the event handler.
612 \twocolitem{{\bf wxSOCKET\_INPUT\_FLAG}}{to receive wxSOCKET\_INPUT}
613 \twocolitem{{\bf wxSOCKET\_OUTPUT\_FLAG}}{to receive wxSOCKET\_OUTPUT}
614 \twocolitem{{\bf wxSOCKET\_CONNECTION\_FLAG}}{to receive wxSOCKET\_CONNECTION}
615 \twocolitem{{\bf wxSOCKET\_LOST\_FLAG}}{to receive wxSOCKET\_LOST}
638 applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait} family
652 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually peeked.
654 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
658 \docparam{buffer}{Buffer where to put peeked data.}
664 Returns a reference to the current object.
687 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
689 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
693 \docparam{buffer}{Buffer where to put read data.}
699 Returns a reference to the current object.
721 on a socket. If the buffer passed to the function isn't big enough, the
723 buffer to be entirely filled, unless an error occurs.
725 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
727 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
731 \docparam{buffer}{Buffer where to put read data.}
737 Returns a reference to the current object.
770 \docparam{buffer}{Buffer to be unread.}
776 Returns a reference to the current object.
801 Note that it is recommended to use the individual Wait functions
802 to wait for the required condition, instead of this one.
806 \docparam{seconds}{Number of seconds to wait.
810 \docparam{millisecond}{Number of milliseconds to wait.}
838 \docparam{seconds}{Number of seconds to wait.
842 \docparam{millisecond}{Number of milliseconds to wait.}
868 \docparam{seconds}{Number of seconds to wait.
872 \docparam{millisecond}{Number of milliseconds to wait.}
891 the socket is ready to send new data, or for streamed sockets, that the
892 connection has been closed, so that a write operation is guaranteed to
898 \docparam{seconds}{Number of seconds to wait.
902 \docparam{millisecond}{Number of milliseconds to wait.}
920 This function writes a buffer of {\it nbytes} bytes to the socket.
922 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually written.
924 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
928 \docparam{buffer}{Buffer with the data to be sent.}
934 Returns a reference to the current object.
959 buffer to be sent, unless an error occurs.
961 Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually written.
963 Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
967 \docparam{buffer}{Buffer with the data to be sent.}
969 \docparam{nbytes}{Number of bytes to send.}
973 Returns a reference to the current object.
1042 Connects to a server using the specified address.
1047 If {\it wait} is false, Connect will try to establish the connection and
1058 \docparam{local}{Bind to the specified local address and port before connecting.
1062 \docparam{wait}{If true, waits for the connection to complete.}
1072 be prepared to handle the completion of this connection request, either
1091 to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to false.
1095 \docparam{seconds}{Number of seconds to wait.
1099 \docparam{millisecond}{Number of milliseconds to wait.}
1106 \helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between
1117 // Wait until the request completes or until we decide to give up
1121     // possibly give some feedback to the user,
1150 To process a socket event, use these event handler macros to direct input
1151 to member functions that take a wxSocketEvent argument.
1183 Returns the socket object to which this event refers to. This makes
1184 it possible to use the same event handler for different sockets.