1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxIP*address, wxSocket* classes
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 A class for working with IPv4 network addresses.
17 class wxIPV4address
: public wxIPaddress
21 Set address to any of the addresses of the current machine.
23 Whenever possible, use this function instead of LocalHost(),
24 as this correctly handles multi-homed hosts and avoids other small
25 problems. Internally, this is the same as setting the IP address
28 @return @true on success, @false if something went wrong.
33 Set the address to hostname, which can be a host name or an IP-style address
34 in dot notation(<tt>a.b.c.d</tt>).
36 @return @true on success, @false if something goes wrong (invalid
37 hostname or invalid IP address).
39 bool Hostname(const wxString
& hostname
);
42 Returns the hostname which matches the IP address.
44 virtual wxString
Hostname() const;
47 Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
49 virtual wxString
IPAddress() const;
52 Set address to localhost (127.0.0.1).
54 Whenever possible, use AnyAddress() instead of this one, as that one will
55 correctly handle multi-homed hosts and avoid other small problems.
57 @return @true on success, @false if something went wrong.
62 Set the port to that corresponding to the specified @a service.
64 @return @true on success, @false if something goes wrong (invalid @a service).
66 bool Service(const wxString
& service
);
69 Set the port to that corresponding to the specified @a service.
71 @return @true on success, @false if something goes wrong (invalid @a service).
73 bool Service(unsigned short service
) = 0;
76 Returns the current service.
78 unsigned short Service() const = 0;
91 class wxSocketServer
: public wxSocketBase
95 Constructs a new server and tries to bind to the specified @e address.
97 Before trying to accept new connections, remember to test whether it succeeded
98 with wxSocketBase:IsOk().
101 Specifies the local address for the server (e.g. port number).
103 Socket flags (See wxSocketBase::SetFlags()).
105 wxSocketServer(const wxSockAddress
& address
,
106 wxSocketFlags flags
= wxSOCKET_NONE
);
109 Destructor (it doesn't close the accepted connections).
111 virtual ~wxSocketServer();
114 Accepts an incoming connection request, and creates a new wxSocketBase
115 object which represents the server-side of the connection.
117 If @a wait is @true and there are no pending connections to be
118 accepted, it will wait for the next incoming connection to
121 @warning: This method will block the GUI.
123 If @a wait is @false, it will try to accept a pending connection
124 if there is one, but it will always return immediately without blocking
125 the GUI. If you want to use Accept() in this way, you can either check for
126 incoming connections with WaitForAccept() or catch @b wxSOCKET_CONNECTION events,
127 then call Accept() once you know that there is an incoming connection waiting
130 @return Returns an opened socket connection, or @NULL if an error
131 occurred or if the wait parameter was @false and there
132 were no pending connections.
134 @see WaitForAccept(), wxSocketBase::SetNotify(),
135 wxSocketBase::Notify(), AcceptWith()
137 wxSocketBase
* Accept(bool wait
= true);
140 Accept an incoming connection using the specified socket object.
143 Socket to be initialized
145 See Accept() for more info.
147 @return Returns @true on success, or @false if an error occurred or
148 if the wait parameter was @false and there were no pending
151 @see WaitForAccept(), wxSocketBase::SetNotify(),
152 wxSocketBase::Notify(), Accept()
154 bool AcceptWith(wxSocketBase
& socket
, bool wait
= true);
157 This function waits for an incoming connection.
159 Use it if you want to call Accept() or AcceptWith() with @e wait set
160 to @false, to detect when an incoming connection is waiting to be accepted.
163 Number of seconds to wait. If -1, it will wait for the default
164 timeout, as set with wxSocketBase::SetTimeout().
166 Number of milliseconds to wait.
168 @return @true if an incoming connection arrived, @false if the timeout
171 @see Accept(), AcceptWith(), wxSocketBase::InterruptWait()
173 bool WaitForAccept(long seconds
= -1, long millisecond
= 0);
181 wxIPaddress is an abstract base class for all internet protocol address
182 objects. Currently, only wxIPV4address is implemented. An experimental
183 implementation for IPV6, wxIPV6address, is being developed.
188 class wxIPaddress
: public wxSockAddress
192 Internally, this is the same as setting the IP address to @b INADDR_ANY.
194 On IPV4 implementations, 0.0.0.0
196 On IPV6 implementations, ::
198 @return @true on success, @false if something went wrong.
200 virtual bool AnyAddress() = 0;
203 Internally, this is the same as setting the IP address to @b INADDR_BROADCAST.
205 On IPV4 implementations, 255.255.255.255
207 @return @true on success, @false if something went wrong.
209 virtual bool BroadcastAddress() = 0;
212 Set the address to hostname, which can be a host name or an IP-style address
213 in a format dependent on implementation.
215 @return @true on success, @false if something goes wrong (invalid
216 hostname or invalid IP address).
218 virtual bool Hostname(const wxString
& hostname
) = 0;
221 Returns the hostname which matches the IP address.
223 virtual wxString
Hostname() const = 0;
226 Returns a wxString containing the IP address.
228 virtual wxString
IPAddress() const = 0;
231 Determines if current address is set to localhost.
233 @return @true if address is localhost, @false if internet address.
235 virtual bool IsLocalHost() const = 0;
238 Set address to localhost.
240 On IPV4 implementations, 127.0.0.1
242 On IPV6 implementations, ::1
244 @return @true on success, @false if something went wrong.
246 virtual bool LocalHost() = 0;
249 Set the port to that corresponding to the specified service.
251 @return @true on success, @false if something goes wrong (invalid @a service).
253 virtual bool Service(const wxString
& service
) = 0;
256 Set the port to that corresponding to the specified service.
258 @return @true on success, @false if something goes wrong (invalid @a service).
260 virtual bool Service(unsigned short service
) = 0;
263 Returns the current service.
265 virtual unsigned short Service() const = 0;
271 @class wxSocketClient
278 class wxSocketClient
: public wxSocketBase
285 Socket flags (See wxSocketBase::SetFlags())
287 wxSocketClient(wxSocketFlags flags
= wxSOCKET_NONE
);
290 Destructor. Please see wxSocketBase::Destroy().
292 virtual ~wxSocketClient();
295 Connects to a server using the specified address.
297 If @a wait is @true, Connect() will wait until the connection
300 @warning: This method will block the GUI.
302 If @a wait is @false, Connect() will try to establish the connection
303 and return immediately, without blocking the GUI. When used this way,
304 even if Connect() returns @false, the connection request can be
305 completed later. To detect this, use WaitOnConnect(), or catch
306 @b wxSOCKET_CONNECTION events (for successful establishment) and
307 @b wxSOCKET_LOST events (for connection failure).
310 Address of the server.
312 If @true, waits for the connection to complete.
314 @return @true if the connection is established and no error occurs.
315 If @a wait was true, and Connect() returns @false, an error
316 occurred and the connection failed.
317 If @a wait was @false, and Connect() returns @false, you should
318 still be prepared to handle the completion of this connection request,
319 either with WaitOnConnect() or by watching wxSOCKET_CONNECTION
320 and wxSOCKET_LOST events.
322 @see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify()
324 virtual bool Connect(const wxSockAddress
& address
, bool wait
= true);
327 Connects to a server using the specified address.
329 If @a wait is @true, Connect() will wait until the connection
330 completes. @b Warning: This will block the GUI.
332 If @a wait is @false, Connect() will try to establish the connection
333 and return immediately, without blocking the GUI. When used this way,
334 even if Connect() returns @false, the connection request can be
335 completed later. To detect this, use WaitOnConnect(), or catch
336 @b wxSOCKET_CONNECTION events (for successful establishment) and
337 @b wxSOCKET_LOST events (for connection failure).
340 Address of the server.
342 Bind to the specified local address and port before connecting.
343 The local address and port can also be set using SetLocal(),
344 and then using the 2-parameter Connect() method.
346 If @true, waits for the connection to complete.
348 @return @true if the connection is established and no error occurs.
349 If @a wait was true, and Connect() returns @false, an error
350 occurred and the connection failed.
351 If @a wait was @false, and Connect() returns @false, you should
352 still be prepared to handle the completion of this connection request,
353 either with WaitOnConnect() or by watching wxSOCKET_CONNECTION
354 and wxSOCKET_LOST events.
356 @see WaitOnConnect(), wxSocketBase::SetNotify(), wxSocketBase::Notify()
358 bool Connect(const wxSockAddress
& address
, const wxSockAddress
& local
,
362 Wait until a connection request completes, or until the specified timeout
363 elapses. Use this function after issuing a call to Connect() with
364 @e wait set to @false.
367 Number of seconds to wait.
368 If -1, it will wait for the default timeout, as set with wxSocketBase::SetTimeout().
370 Number of milliseconds to wait.
373 WaitOnConnect() returns @true if the connection request completes.
374 This does not necessarily mean that the connection was
375 successfully established; it might also happen that the
376 connection was refused by the peer. Use wxSocketBase::IsConnected()
377 to distinguish between these two situations.
378 @n @n If the timeout elapses, WaitOnConnect() returns @false.
379 @n @n These semantics allow code like this:
381 // Issue the connection request
382 client->Connect(addr, false);
384 // Wait until the request completes or until we decide to give up
385 bool waitmore = true;
386 while ( !client->WaitOnConnect(seconds, millis) && waitmore )
388 // possibly give some feedback to the user,
389 // and update waitmore as needed.
391 bool success = client->IsConnected();
394 bool WaitOnConnect(long seconds
= -1, long milliseconds
= 0);
402 You are unlikely to need to use this class: only wxSocketBase uses it.
407 @see wxSocketBase, wxIPaddress, wxIPV4address
409 class wxSockAddress
: public wxObject
420 virtual ~wxSockAddress();
423 Delete all informations about the address.
425 virtual void Clear();
428 Returns the length of the socket address.
438 This event class contains information about socket events.
440 @beginEventTable{wxSocketEvent}
441 @event{EVT_SOCKET(id, func)}
442 Process a socket event, supplying the member function.
448 @see wxSocketBase, wxSocketClient, wxSocketServer
450 class wxSocketEvent
: public wxEvent
456 wxSocketEvent(int id
= 0);
459 Gets the client data of the socket which generated this event, as
460 set with wxSocketBase::SetClientData().
462 void* GetClientData() const;
465 Returns the socket object to which this event refers to.
466 This makes it possible to use the same event handler for different sockets.
468 wxSocketBase
* GetSocket() const;
471 Returns the socket event type.
473 wxSocketNotify
GetSocketEvent() const;
478 wxSocket error return values.
482 wxSOCKET_NOERROR
, ///< No error happened.
483 wxSOCKET_INVOP
, ///< Invalid operation.
484 wxSOCKET_IOERR
, ///< Input/Output error.
485 wxSOCKET_INVADDR
, ///< Invalid address passed to wxSocket.
486 wxSOCKET_INVSOCK
, ///< Invalid socket (uninitialized).
487 wxSOCKET_NOHOST
, ///< No corresponding host.
488 wxSOCKET_INVPORT
, ///< Invalid port.
489 wxSOCKET_WOULDBLOCK
, ///< The socket is non-blocking and the operation would block.
490 wxSOCKET_TIMEDOUT
, ///< The timeout for this operation expired.
491 wxSOCKET_MEMERR
///< Memory exhausted.
496 @anchor wxSocketEventFlags
498 wxSocket Event Flags.
500 A brief note on how to use these events:
502 The @b wxSOCKET_INPUT event will be issued whenever there is data available
503 for reading. This will be the case if the input queue was empty and new data
504 arrives, or if the application has read some data yet there is still more data
505 available. This means that the application does not need to read all available
506 data in response to a @b wxSOCKET_INPUT event, as more events will be produced
509 The @b wxSOCKET_OUTPUT event is issued when a socket is first connected with
510 Connect() or accepted with Accept(). After that, new events will be generated
511 only after an output operation fails with @b wxSOCKET_WOULDBLOCK and buffer space
512 becomes available again. This means that the application should assume that it can
513 write data to the socket until an @b wxSOCKET_WOULDBLOCK error occurs; after this,
514 whenever the socket becomes writable again the application will be notified with
515 another @b wxSOCKET_OUTPUT event.
517 The @b wxSOCKET_CONNECTION event is issued when a delayed connection request completes
518 successfully (client) or when a new connection arrives at the incoming queue (server).
520 The @b wxSOCKET_LOST event is issued when a close indication is received for the socket.
521 This means that the connection broke down or that it was closed by the peer. Also, this
522 event will be issued if a connection request fails.
524 enum wxSocketEventFlags
526 wxSOCKET_INPUT
, ///< There is data available for reading.
527 wxSOCKET_OUTPUT
, ///< The socket is ready to be written to.
528 wxSOCKET_CONNECTION
, ///< Incoming connection request (server), or
529 ///< successful connection establishment (client).
530 wxSOCKET_LOST
///< The connection has been closed.
535 @anchor wxSocketFlags
539 A brief overview on how to use these flags follows.
541 If no flag is specified (this is the same as @b wxSOCKET_NONE),
542 IO calls will return after some data has been read or written, even
543 when the transfer might not be complete. This is the same as issuing
544 exactly one blocking low-level call to @b recv() or @b send(). Note
545 that @e blocking here refers to when the function returns, not
546 to whether the GUI blocks during this time.
548 If @b wxSOCKET_NOWAIT is specified, IO calls will return immediately.
549 Read operations will retrieve only available data. Write operations will
550 write as much data as possible, depending on how much space is available
551 in the output buffer. This is the same as issuing exactly one nonblocking
552 low-level call to @b recv() or @b send(). Note that @e nonblocking here
553 refers to when the function returns, not to whether the GUI blocks during
556 If @b wxSOCKET_WAITALL is specified, IO calls won't return until ALL
557 the data has been read or written (or until an error occurs), blocking if
558 necessary, and issuing several low level calls if necessary. This is the
559 same as having a loop which makes as many blocking low-level calls to
560 @b recv() or @b send() as needed so as to transfer all the data. Note
561 that @e blocking here refers to when the function returns, not
562 to whether the GUI blocks during this time.
564 The @b wxSOCKET_BLOCK flag controls whether the GUI blocks during
565 IO operations. If this flag is specified, the socket will not yield
566 during IO calls, so the GUI will remain blocked until the operation
567 completes. If it is not used, then the application must take extra
568 care to avoid unwanted reentrance.
570 The @b wxSOCKET_REUSEADDR flag controls the use of the @b SO_REUSEADDR standard
571 @b setsockopt() flag. This flag allows the socket to bind to a port that is
572 already in use. This is mostly used on UNIX-based systems to allow rapid starting
573 and stopping of a server, otherwise you may have to wait several minutes for the
574 port to become available.
576 @b wxSOCKET_REUSEADDR can also be used with socket clients to (re)bind to a
577 particular local port for an outgoing connection.
578 This option can have surprising platform dependent behavior, so check the
579 documentation for your platform's implementation of setsockopt().
581 Note that on BSD-based systems(e.g. Mac OS X), use of
582 @b wxSOCKET_REUSEADDR implies @b SO_REUSEPORT in addition to
583 @b SO_REUSEADDR to be consistent with Windows.
585 The @b wxSOCKET_BROADCAST flag controls the use of the @b SO_BROADCAST standard
586 @b setsockopt() flag. This flag allows the socket to use the broadcast address,
587 and is generally used in conjunction with @b wxSOCKET_NOBIND and
588 wxIPaddress::BroadcastAddress().
591 - @b wxSOCKET_NONE will try to read at least SOME data, no matter how much.
592 - @b wxSOCKET_NOWAIT will always return immediately, even if it cannot
593 read or write ANY data.
594 - @b wxSOCKET_WAITALL will only return when it has read or written ALL
596 - @b wxSOCKET_BLOCK has nothing to do with the previous flags and
597 it controls whether the GUI blocks.
598 - @b wxSOCKET_REUSEADDR controls special platform-specific behavior for
599 reusing local addresses/ports.
603 wxSOCKET_NONE
= 0, ///< Normal functionality.
604 wxSOCKET_NOWAIT
= 1, ///< Read/write as much data as possible and return immediately.
605 wxSOCKET_WAITALL
= 2, ///< Wait for all required data to be read/written unless an error occurs.
606 wxSOCKET_BLOCK
= 4, ///< Block the GUI (do not yield) while reading/writing data.
607 wxSOCKET_REUSEADDR
= 8, ///< Allows the use of an in-use port (wxServerSocket only)
608 wxSOCKET_BROADCAST
= 16, ///< Switches the socket to broadcast mode
609 wxSOCKET_NOBIND
= 32 ///< Stops the socket from being bound to a specific
610 ///< adapter (normally used in conjunction with
611 ///< @b wxSOCKET_BROADCAST)
618 wxSocketBase is the base class for all socket-related objects, and it
619 defines all basic IO functionality.
622 When using wxSocket from multiple threads, even implicitly (e.g. by using
623 wxFTP or wxHTTP in another thread) you must initialize the sockets from the
624 main thread by calling Initialize() before creating the other ones.
626 @beginEventTable{wxSocketEvent}
627 @event{EVT_SOCKET(id, func)}
628 Process a @c wxEVT_SOCKET event.
629 See @ref wxSocketEventFlags and @ref wxSocketFlags for more info.
635 @see wxSocketEvent, wxSocketClient, wxSocketServer, @sample{sockets},
636 @ref wxSocketFlags, ::wxSocketEventFlags, ::wxSocketError
638 class wxSocketBase
: public wxObject
643 @name Construction and Destruction
650 Don't use it directly; instead, use wxSocketClient to construct a socket client,
651 or wxSocketServer to construct a socket server.
658 Do not destroy a socket using the delete operator directly;
659 use Destroy() instead. Also, do not create socket objects in the stack.
664 Destroys the socket safely.
666 Use this function instead of the delete operator, since otherwise socket events
667 could reach the application even after the socket has been destroyed. To prevent
668 this problem, this function appends the wxSocket to a list of object to be deleted
669 on idle time, after all events have been processed. For the same reason, you should
670 avoid creating socket objects in the stack.
672 Destroy() calls Close() automatically.
674 @return Always @true.
679 Perform the initialization needed in order to use the sockets.
681 This function is called from wxSocket constructor implicitly and so
682 normally doesn't need to be called explicitly. There is however one
683 important exception: as this function must be called from the main
684 (UI) thread, if you use wxSocket from multiple threads you must call
685 Initialize() from the main thread before creating wxSocket objects in
688 It is safe to call this function multiple times (only the first call
689 does anything) but you must call Shutdown() exactly once for every call
693 @true if the sockets can be used, @false if the initialization
694 failed and sockets are not available at all.
696 static bool Initialize();
699 Shut down the sockets.
701 This function undoes the call to Initialize() and must be called after
702 every successful call to Initialize().
704 static void Shutdown();
715 Returns @true if an error occurred in the last IO operation.
717 Use this function to check for an error condition after one of the
718 following calls: Discard(), Peek(), Read(), ReadMsg(), Unread(), Write(), WriteMsg().
723 This function returns the local address field of the socket. The local
724 address field contains the complete local address of the socket (local
725 address, local port, ...).
727 @return @true if no error happened, @false otherwise.
729 bool GetLocal(wxSockAddress
& addr
) const;
732 This function returns the peer address field of the socket. The peer
733 address field contains the complete peer host address of the socket
734 (address, port, ...).
736 @return @true if no error happened, @false otherwise.
738 bool GetPeer(wxSockAddress
& addr
) const;
741 Return the socket timeout in seconds.
743 The timeout can be set using SetTimeout() and is 10 minutes by default.
745 long GetTimeout() const;
748 Returns @true if the socket is connected.
750 bool IsConnected() const;
753 This function waits until the socket is readable.
755 This might mean that queued data is available for reading or, for streamed
756 sockets, that the connection has been closed, so that a read operation will
757 complete immediately without blocking (unless the @b wxSOCKET_WAITALL flag
758 is set, in which case the operation might still block).
763 Returns @true if the socket is not connected.
765 bool IsDisconnected() const;
768 Returns @true if the socket is initialized and ready and @false in other
772 For wxSocketClient, IsOk() won't return @true unless the client is connected to a server.
773 For wxSocketServer, IsOk() will return @true if the server could bind to the specified address
774 and is already listening for new connections.
775 IsOk() does not check for IO errors; use Error() instead for that purpose.
780 Returns the number of bytes read or written by the last IO call.
782 Use this function to get the number of bytes actually transferred
783 after using one of the following IO calls: Discard(), Peek(), Read(),
784 ReadMsg(), Unread(), Write(), WriteMsg().
786 wxUint32
LastCount() const;
789 Returns the last wxSocket error. See @ref wxSocketError .
792 This function merely returns the last error code,
793 but it should not be used to determine if an error has occurred (this
794 is because successful operations do not change the LastError value).
795 Use Error() first, in order to determine if the last IO call failed.
796 If this returns @true, use LastError() to discover the cause of the error.
798 wxSocketError
LastError() const;
801 This function restores the previous state of the socket, as saved
804 Calls to SaveState() and RestoreState() can be nested.
811 This function saves the current state of the socket in a stack.
812 Socket state includes flags, as set with SetFlags(), event mask, as set
813 with SetNotify() and Notify(), user data, as set with SetClientData().
814 Calls to SaveState and RestoreState can be nested.
826 See also: wxSocketServer::WaitForAccept(), wxSocketClient::WaitOnConnect()
831 This function shuts down the socket, disabling further transmission and
832 reception of data; it also disables events for the socket and frees the
833 associated system resources.
835 Upon socket destruction, Close() is automatically called, so in most cases
836 you won't need to do it yourself, unless you explicitly want to shut down
837 the socket, typically to notify the peer that you are closing the connection.
840 Although Close() immediately disables events for the socket, it is possible
841 that event messages may be waiting in the application's event queue.
842 The application must therefore be prepared to handle socket event messages even
843 after calling Close().
848 Shuts down the writing end of the socket.
850 This function simply calls the standard shutdown() function on the
851 underlying socket, indicating that nothing will be written to this
854 void ShutdownOutput();
857 This function simply deletes all bytes in the incoming queue. This function
858 always returns immediately and its operation is not affected by IO flags.
860 Use LastCount() to verify the number of bytes actually discarded.
862 If you use Error(), it will always return @false.
864 wxSocketBase
Discard();
867 Returns current IO flags, as set with SetFlags()
869 wxSocketFlags
GetFlags() const;
872 Use this function to interrupt any wait operation currently in progress.
874 Note that this is not intended as a regular way to interrupt a Wait call,
875 but only as an escape mechanism for exceptional situations where it is
876 absolutely necessary to use it, for example to abort an operation due to
877 some exception or abnormal problem. InterruptWait is automatically called
878 when you Close() a socket (and thus also upon
879 socket destruction), so you don't need to use it in these cases.
881 @see Wait(), WaitForLost(), WaitForRead(), WaitForWrite(),
882 wxSocketServer::WaitForAccept(), wxSocketClient::WaitOnConnect()
884 void InterruptWait();
887 This function peeks a buffer of @a nbytes bytes from the socket.
889 Peeking a buffer doesn't delete it from the socket input queue.
891 Use LastCount() to verify the number of bytes actually peeked.
893 Use Error() to determine if the operation succeeded.
896 Buffer where to put peeked data.
900 @return Returns a reference to the current object.
903 The exact behaviour of Peek() depends on the combination of flags being used.
904 For a detailed explanation, see SetFlags()
906 @see Error(), LastError(), LastCount(), SetFlags()
908 wxSocketBase
Peek(void* buffer
, wxUint32 nbytes
);
911 This function reads a buffer of @a nbytes bytes from the socket.
912 Use LastCount() to verify the number of bytes actually read.
913 Use Error() to determine if the operation succeeded.
916 Buffer where to put read data.
920 @return Returns a reference to the current object.
923 The exact behaviour of Read() depends on the combination of flags being used.
924 For a detailed explanation, see SetFlags()
926 @see Error(), LastError(), LastCount(),
929 wxSocketBase
Read(void* buffer
, wxUint32 nbytes
);
932 This function reads a buffer sent by WriteMsg()
933 on a socket. If the buffer passed to the function isn't big enough, the
934 remaining bytes will be discarded. This function always waits for the
935 buffer to be entirely filled, unless an error occurs.
937 Use LastCount() to verify the number of bytes actually read.
939 Use Error() to determine if the operation succeeded.
942 Buffer where to put read data.
946 @return Returns a reference to the current object.
949 ReadMsg() will behave as if the @b wxSOCKET_WAITALL flag was always set
950 and it will always ignore the @b wxSOCKET_NOWAIT flag.
951 The exact behaviour of ReadMsg() depends on the @b wxSOCKET_BLOCK flag.
952 For a detailed explanation, see SetFlags().
954 @see Error(), LastError(), LastCount(), SetFlags(), WriteMsg()
956 wxSocketBase
ReadMsg(void* buffer
, wxUint32 nbytes
);
959 Use SetFlags to customize IO operation for this socket.
961 The @a flags parameter may be a combination of flags ORed together.
962 Notice that not all combinations of flags affecting the IO calls
963 (Read() and Write()) make sense, e.g. @b wxSOCKET_NOWAIT can't be
964 combined with @b wxSOCKET_WAITALL nor with @b wxSOCKET_BLOCK.
966 The following flags can be used:
969 Default mode: the socket will read some data in the IO calls and
970 will process events to avoid blocking UI while waiting for the data
972 @flag{wxSOCKET_NOWAIT}
973 Don't wait for the socket to become ready in IO calls, read as much
974 data as is available -- potentially 0 bytes -- and return
976 @flag{wxSOCKET_WAITALL}
977 Don't return before the entire amount of data specified in IO calls
978 is read or written unless an error occurs. If this flag is not
979 specified, the IO calls return as soon as any amount of data, even
980 less than the total number of bytes, is processed.
981 @flag{wxSOCKET_BLOCK}
982 Don't process the UI events while waiting for the socket to become
983 ready. This means that UI will be unresponsive during socket IO.
984 @flag{wxSOCKET_REUSEADDR}
985 Allows the use of an in-use port (wxServerSocket only).
986 @flag{wxSOCKET_BROADCAST}
987 Switches the socket to broadcast mode.
988 @flag{wxSOCKET_NOBIND}
989 Stops the socket from being bound to a specific adapter (normally
990 used in conjunction with @b wxSOCKET_BROADCAST).
993 For more information on socket events see @ref wxSocketFlags .
995 void SetFlags(wxSocketFlags flags
);
998 This function allows you to set the local address and port,
999 useful when an application needs to reuse a particular port. When
1000 a local port is set for a wxSocketClient,
1001 @b bind() will be called before @b connect().
1003 bool SetLocal(const wxIPV4address
& local
);
1006 This function sets the default socket timeout in seconds. This timeout
1007 applies to all IO calls, and also to the Wait() family
1008 of functions if you don't specify a wait interval. Initially, the default
1009 timeout is 10 minutes.
1011 void SetTimeout(int seconds
);
1014 This function unreads a buffer. That is, the data in the buffer is put back
1015 in the incoming queue. This function is not affected by wxSocket flags.
1017 If you use LastCount(), it will always return @a nbytes.
1019 If you use Error(), it will always return @false.
1022 Buffer to be unread.
1026 @return Returns a reference to the current object.
1028 @see Error(), LastCount(), LastError()
1030 wxSocketBase
Unread(const void* buffer
, wxUint32 nbytes
);
1033 This function waits until any of the following conditions is @true:
1035 @li The socket becomes readable.
1036 @li The socket becomes writable.
1037 @li An ongoing connection request has completed (wxSocketClient only)
1038 @li An incoming connection request has arrived (wxSocketServer only)
1039 @li The connection has been closed.
1041 Note that it is recommended to use the individual Wait functions
1042 to wait for the required condition, instead of this one.
1045 Number of seconds to wait.
1046 If -1, it will wait for the default timeout,
1047 as set with SetTimeout().
1049 Number of milliseconds to wait.
1051 @return Returns @true when any of the above conditions is satisfied,
1052 @false if the timeout was reached.
1054 @see InterruptWait(), wxSocketServer::WaitForAccept(),
1055 WaitForLost(), WaitForRead(),
1056 WaitForWrite(), wxSocketClient::WaitOnConnect()
1058 bool Wait(long seconds
= -1, long millisecond
= 0);
1061 This function waits until the connection is lost. This may happen if
1062 the peer gracefully closes the connection or if the connection breaks.
1065 Number of seconds to wait.
1066 If -1, it will wait for the default timeout,
1067 as set with SetTimeout().
1069 Number of milliseconds to wait.
1071 @return Returns @true if the connection was lost, @false if the timeout
1074 @see InterruptWait(), Wait()
1076 bool WaitForLost(long seconds
= -1, long millisecond
= 0);
1079 This function waits until the socket is readable.
1081 This might mean that queued data is available for reading or, for streamed
1082 sockets, that the connection has been closed, so that a read operation will
1083 complete immediately without blocking (unless the @b wxSOCKET_WAITALL flag
1084 is set, in which case the operation might still block).
1087 Number of seconds to wait.
1088 If -1, it will wait for the default timeout,
1089 as set with SetTimeout().
1091 Number of milliseconds to wait.
1093 @return Returns @true if the socket becomes readable, @false on timeout.
1095 @see InterruptWait(), Wait()
1097 bool WaitForRead(long seconds
= -1, long millisecond
= 0);
1100 This function waits until the socket becomes writable.
1102 This might mean that the socket is ready to send new data, or for streamed
1103 sockets, that the connection has been closed, so that a write operation is
1104 guaranteed to complete immediately (unless the @b wxSOCKET_WAITALL flag is set,
1105 in which case the operation might still block).
1108 Number of seconds to wait.
1109 If -1, it will wait for the default timeout,
1110 as set with SetTimeout().
1112 Number of milliseconds to wait.
1114 @return Returns @true if the socket becomes writable, @false on timeout.
1116 @see InterruptWait(), Wait()
1118 bool WaitForWrite(long seconds
= -1, long millisecond
= 0);
1121 This function writes a buffer of @a nbytes bytes to the socket.
1123 Use LastCount() to verify the number of bytes actually written.
1125 Use Error() to determine if the operation succeeded.
1128 Buffer with the data to be sent.
1132 @return Returns a reference to the current object.
1136 The exact behaviour of Write() depends on the combination of flags being used.
1137 For a detailed explanation, see SetFlags().
1139 @see Error(), LastError(), LastCount(), SetFlags()
1141 wxSocketBase
Write(const void* buffer
, wxUint32 nbytes
);
1144 This function writes a buffer of @a nbytes bytes from the socket, but it
1145 writes a short header before so that ReadMsg() knows how much data should
1146 it actually read. So, a buffer sent with WriteMsg() MUST be read with ReadMsg().
1148 This function always waits for the entire buffer to be sent, unless an error occurs.
1150 Use LastCount() to verify the number of bytes actually written.
1152 Use Error() to determine if the operation succeeded.
1155 Buffer with the data to be sent.
1157 Number of bytes to send.
1159 @return Returns a reference to the current object.
1163 WriteMsg() will behave as if the @b wxSOCKET_WAITALL flag was always set and
1164 it will always ignore the @b wxSOCKET_NOWAIT flag. The exact behaviour of
1165 WriteMsg() depends on the @b wxSOCKET_BLOCK flag. For a detailed explanation,
1168 @see Error(), LastError(), LastCount(), SetFlags(), ReadMsg()
1171 wxSocketBase
WriteMsg(const void* buffer
, wxUint32 nbytes
);
1177 @name Handling Socket Events
1182 Returns a pointer of the client data for this socket, as set with
1185 void* GetClientData() const;
1188 According to the @a notify value, this function enables
1189 or disables socket events. If @a notify is @true, the events
1190 configured with SetNotify() will
1191 be sent to the application. If @a notify is @false; no events
1194 void Notify(bool notify
);
1197 Sets user-supplied client data for this socket. All socket events will
1198 contain a pointer to this data, which can be retrieved with
1199 the wxSocketEvent::GetClientData() function.
1201 void SetClientData(void* data
);
1204 Sets an event handler to be called when a socket event occurs. The
1205 handler will be called for those events for which notification is
1206 enabled with SetNotify() and
1210 Specifies the event handler you want to use.
1212 The id of socket event.
1214 @see SetNotify(), Notify(), wxSocketEvent, wxEvtHandler
1216 void SetEventHandler(wxEvtHandler
& handler
, int id
= -1);
1219 Specifies which socket events are to be sent to the event handler.
1220 The @a flags parameter may be combination of flags ORed together. The
1221 following flags can be used:
1224 @flag{wxSOCKET_INPUT_FLAG} to receive @b wxSOCKET_INPUT.
1225 @flag{wxSOCKET_OUTPUT_FLAG} to receive @b wxSOCKET_OUTPUT.
1226 @flag{wxSOCKET_CONNECTION_FLAG} to receive @b wxSOCKET_CONNECTION.
1227 @flag{wxSOCKET_LOST_FLAG} to receive @b wxSOCKET_LOST.
1233 sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
1237 In this example, the user will be notified about incoming socket data and
1238 whenever the connection is closed.
1240 For more information on socket events see @ref wxSocketEventFlags .
1242 void SetNotify(wxSocketEventFlags flags
);
1250 @class wxDatagramSocket
1257 class wxDatagramSocket
: public wxSocketBase
1266 Socket flags (See wxSocketBase::SetFlags()).
1268 wxDatagramSocket(const wxSockAddress
& addr
,
1269 wxSocketFlags flags
= wxSOCKET_NONE
);
1272 Destructor. Please see wxSocketBase::Destroy().
1274 virtual ~wxDatagramSocket();
1277 This function writes a buffer of @a nbytes bytes to the socket.
1278 Use wxSocketBase::LastCount() to verify the number of bytes actually wrote.
1279 Use wxSocketBase::Error() to determine if the operation succeeded.
1282 The address of the destination peer for this data.
1284 Buffer where read data is.
1288 @return Returns a reference to the current object.
1290 @see wxSocketBase::LastError(), wxSocketBase::SetFlags()
1292 wxDatagramSocket
& SendTo(const wxSockAddress
& address
,
1293 const void* buffer
, wxUint32 nbytes
);