1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/socket.cpp
3 // Purpose: Socket handler classes
4 // Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
6 // Copyright: (C) 1999-1997, Guilhem Lavaux
7 // (C) 1999-2000, Guillermo Rodriguez Garcia
8 // (C) 2008 Vadim Zeitlin
10 // License: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 // ==========================================================================
15 // ==========================================================================
17 // For compilers that support precompilation, includes "wx.h".
18 #include "wx/wxprec.h"
26 #include "wx/socket.h"
29 #include "wx/object.h"
30 #include "wx/string.h"
37 #include "wx/module.h"
40 #include "wx/apptrait.h"
41 #include "wx/sckaddr.h"
42 #include "wx/stopwatch.h"
43 #include "wx/thread.h"
44 #include "wx/evtloop.h"
46 #include "wx/private/fd.h"
47 #include "wx/private/socket.h"
53 // we use MSG_NOSIGNAL to avoid getting SIGPIPE when sending data to a remote
54 // host which closed the connection if it is available, otherwise we rely on
55 // SO_NOSIGPIPE existency
57 // this should cover all the current Unix systems (Windows never sends any
58 // signals anyhow) but if we find one that has neither we should explicitly
59 // ignore SIGPIPE for it
61 #define wxSOCKET_MSG_NOSIGNAL MSG_NOSIGNAL
62 #else // MSG_NOSIGNAL not available (BSD including OS X)
63 #if defined(__UNIX__) && !defined(SO_NOSIGPIPE)
64 #error "Writing to socket could generate unhandled SIGPIPE."
65 #error "Please post information about your system to wx-dev."
68 #define wxSOCKET_MSG_NOSIGNAL 0
71 // DLL options compatibility check:
73 WX_CHECK_BUILD_OPTIONS("wxNet")
75 // --------------------------------------------------------------------------
76 // macros and constants
77 // --------------------------------------------------------------------------
80 #define MAX_DISCARD_SIZE (10 * 1024)
82 #define wxTRACE_Socket _T("wxSocket")
84 // --------------------------------------------------------------------------
86 // --------------------------------------------------------------------------
88 IMPLEMENT_CLASS(wxSocketBase
, wxObject
)
89 IMPLEMENT_CLASS(wxSocketServer
, wxSocketBase
)
90 IMPLEMENT_CLASS(wxSocketClient
, wxSocketBase
)
91 IMPLEMENT_CLASS(wxDatagramSocket
, wxSocketBase
)
92 IMPLEMENT_DYNAMIC_CLASS(wxSocketEvent
, wxEvent
)
94 // ----------------------------------------------------------------------------
96 // ----------------------------------------------------------------------------
101 void SetTimeValFromMS(timeval
& tv
, unsigned long ms
)
103 tv
.tv_sec
= (ms
/ 1000);
104 tv
.tv_usec
= (ms
% 1000) * 1000;
107 } // anonymous namespace
109 // --------------------------------------------------------------------------
111 // --------------------------------------------------------------------------
113 class wxSocketState
: public wxObject
116 wxSocketFlags m_flags
;
117 wxSocketEventFlags m_eventmask
;
122 wxSocketState() : wxObject() {}
124 DECLARE_NO_COPY_CLASS(wxSocketState
)
127 // ============================================================================
129 // ============================================================================
131 wxSocketManager
*wxSocketManager::ms_manager
= NULL
;
134 void wxSocketManager::Set(wxSocketManager
*manager
)
136 wxASSERT_MSG( !ms_manager
, "too late to set manager now" );
138 ms_manager
= manager
;
142 void wxSocketManager::Init()
144 wxASSERT_MSG( !ms_manager
, "shouldn't be initialized twice" );
147 Details: Initialize() creates a hidden window as a sink for socket
148 events, such as 'read completed'. wxMSW has only one message loop
149 for the main thread. If Initialize is called in a secondary thread,
150 the socket window will be created for the secondary thread, but
151 since there is no message loop on this thread, it will never
152 receive events and all socket operations will time out.
153 BTW, the main thread must not be stopped using sleep or block
154 on a semaphore (a bad idea in any case) or socket operations
157 On the Mac side, Initialize() stores a pointer to the CFRunLoop for
158 the main thread. Because secondary threads do not have run loops,
159 adding event notifications to the "Current" loop would have no
160 effect at all, events would never fire.
162 wxASSERT_MSG( wxIsMainThread(),
163 "sockets must be initialized from the main thread" );
165 wxAppConsole
* const app
= wxAppConsole::GetInstance();
166 wxCHECK_RET( app
, "sockets can't be initialized without wxApp" );
168 ms_manager
= app
->GetTraits()->GetSocketManager();
171 // ==========================================================================
173 // ==========================================================================
175 wxSocketImpl::wxSocketImpl(wxSocketBase
& wxsocket
)
176 : m_wxsocket(&wxsocket
)
178 m_fd
= INVALID_SOCKET
;
179 m_error
= wxSOCKET_NOERROR
;
183 SetTimeout(wxsocket
.GetTimeout() * 1000);
185 m_establishing
= false;
189 m_initialRecvBufferSize
= -1;
190 m_initialSendBufferSize
= -1;
193 wxSocketImpl::~wxSocketImpl()
195 if ( m_fd
!= INVALID_SOCKET
)
199 bool wxSocketImpl::PreCreateCheck(const wxSockAddressImpl
& addr
)
201 if ( m_fd
!= INVALID_SOCKET
)
203 m_error
= wxSOCKET_INVSOCK
;
209 m_error
= wxSOCKET_INVADDR
;
216 void wxSocketImpl::PostCreation()
218 // FreeBSD variants can't use MSG_NOSIGNAL, and instead use a socket option
220 EnableSocketOption(SO_NOSIGPIPE
);
224 EnableSocketOption(SO_REUSEADDR
);
228 wxASSERT_MSG( !m_stream
, "broadcasting is for datagram sockets only" );
230 EnableSocketOption(SO_BROADCAST
);
233 if ( m_initialRecvBufferSize
>= 0 )
234 SetSocketOption(SO_RCVBUF
, m_initialRecvBufferSize
);
235 if ( m_initialSendBufferSize
>= 0 )
236 SetSocketOption(SO_SNDBUF
, m_initialSendBufferSize
);
238 // we always put our sockets in unblocked mode and handle blocking
239 // ourselves in DoRead/Write() if wxSOCKET_WAITALL is specified
240 UnblockAndRegisterWithEventLoop();
243 wxSocketError
wxSocketImpl::UpdateLocalAddress()
245 WX_SOCKLEN_T lenAddr
= m_local
.GetLen();
246 if ( getsockname(m_fd
, m_local
.GetWritableAddr(), &lenAddr
) != 0 )
249 m_error
= wxSOCKET_IOERR
;
253 return wxSOCKET_NOERROR
;
256 wxSocketError
wxSocketImpl::CreateServer()
258 if ( !PreCreateCheck(m_local
) )
264 // do create the socket
265 m_fd
= socket(m_local
.GetFamily(), SOCK_STREAM
, 0);
267 if ( m_fd
== INVALID_SOCKET
)
269 m_error
= wxSOCKET_IOERR
;
270 return wxSOCKET_IOERR
;
275 // and then bind to and listen on it
277 // FIXME: should we test for m_dobind here?
278 if ( bind(m_fd
, m_local
.GetAddr(), m_local
.GetLen()) != 0 )
279 m_error
= wxSOCKET_IOERR
;
283 if ( listen(m_fd
, 5) != 0 )
284 m_error
= wxSOCKET_IOERR
;
293 // finally retrieve the address we effectively bound to
294 return UpdateLocalAddress();
297 wxSocketError
wxSocketImpl::CreateClient(bool wait
)
299 if ( !PreCreateCheck(m_peer
) )
302 m_fd
= socket(m_peer
.GetFamily(), SOCK_STREAM
, 0);
304 if ( m_fd
== INVALID_SOCKET
)
306 m_error
= wxSOCKET_IOERR
;
307 return wxSOCKET_IOERR
;
312 // If a local address has been set, then bind to it before calling connect
313 if ( m_local
.IsOk() )
315 if ( bind(m_fd
, m_local
.GetAddr(), m_local
.GetLen()) != 0 )
318 m_error
= wxSOCKET_IOERR
;
324 int rc
= connect(m_fd
, m_peer
.GetAddr(), m_peer
.GetLen());
325 if ( rc
== SOCKET_ERROR
)
327 wxSocketError err
= GetLastError();
328 if ( err
== wxSOCKET_WOULDBLOCK
)
330 m_establishing
= true;
332 // block waiting for connection if we should (otherwise just return
333 // wxSOCKET_WOULDBLOCK to the caller)
336 err
= SelectWithTimeout(wxSOCKET_CONNECTION_FLAG
)
339 m_establishing
= false;
347 m_error
= wxSOCKET_NOERROR
;
354 wxSocketError
wxSocketImpl::CreateUDP()
356 if ( !PreCreateCheck(m_local
) )
362 m_fd
= socket(m_local
.GetFamily(), SOCK_DGRAM
, 0);
364 if ( m_fd
== INVALID_SOCKET
)
366 m_error
= wxSOCKET_IOERR
;
367 return wxSOCKET_IOERR
;
374 if ( bind(m_fd
, m_local
.GetAddr(), m_local
.GetLen()) != 0 )
377 m_error
= wxSOCKET_IOERR
;
381 return UpdateLocalAddress();
384 return wxSOCKET_NOERROR
;
387 wxSocketImpl
*wxSocketImpl::Accept(wxSocketBase
& wxsocket
)
389 wxSockAddressStorage from
;
390 WX_SOCKLEN_T fromlen
= sizeof(from
);
391 const SOCKET fd
= accept(m_fd
, &from
.addr
, &fromlen
);
393 if ( fd
== INVALID_SOCKET
)
396 wxSocketImpl
* const sock
= Create(wxsocket
);
398 sock
->m_peer
= wxSockAddressImpl(from
.addr
, fromlen
);
400 sock
->UnblockAndRegisterWithEventLoop();
406 void wxSocketImpl::Close()
408 if ( m_fd
!= INVALID_SOCKET
)
411 m_fd
= INVALID_SOCKET
;
416 * Disallow further read/write operations on this socket, close
417 * the fd and disable all callbacks.
419 void wxSocketImpl::Shutdown()
421 if ( m_fd
!= INVALID_SOCKET
)
423 shutdown(m_fd
, 1 /* SD_SEND */);
429 * Sets the timeout for blocking calls. Time is expressed in
432 void wxSocketImpl::SetTimeout(unsigned long millis
)
434 SetTimeValFromMS(m_timeout
, millis
);
437 void wxSocketImpl::NotifyOnStateChange(wxSocketNotify event
)
439 m_wxsocket
->OnRequest(event
);
442 /* Address handling */
443 wxSocketError
wxSocketImpl::SetLocal(const wxSockAddressImpl
& local
)
445 /* the socket must be initialized, or it must be a server */
446 if (m_fd
!= INVALID_SOCKET
&& !m_server
)
448 m_error
= wxSOCKET_INVSOCK
;
449 return wxSOCKET_INVSOCK
;
454 m_error
= wxSOCKET_INVADDR
;
455 return wxSOCKET_INVADDR
;
460 return wxSOCKET_NOERROR
;
463 wxSocketError
wxSocketImpl::SetPeer(const wxSockAddressImpl
& peer
)
467 m_error
= wxSOCKET_INVADDR
;
468 return wxSOCKET_INVADDR
;
473 return wxSOCKET_NOERROR
;
476 const wxSockAddressImpl
& wxSocketImpl::GetLocal()
478 if ( !m_local
.IsOk() )
479 UpdateLocalAddress();
484 // ----------------------------------------------------------------------------
486 // ----------------------------------------------------------------------------
488 // this macro wraps the given expression (normally a syscall) in a loop which
489 // ignores any interruptions, i.e. reevaluates it again if it failed and errno
492 #define DO_WHILE_EINTR( rc, syscall ) \
496 while ( rc == -1 && errno == EINTR )
498 #define DO_WHILE_EINTR( rc, syscall ) rc = (syscall)
501 int wxSocketImpl::RecvStream(void *buffer
, int size
)
504 DO_WHILE_EINTR( ret
, recv(m_fd
, static_cast<char *>(buffer
), size
, 0) );
508 // receiving 0 bytes for a TCP socket indicates that the connection was
509 // closed by peer so shut down our end as well (for UDP sockets empty
510 // datagrams are also possible)
511 m_establishing
= false;
512 NotifyOnStateChange(wxSOCKET_LOST
);
516 // do not return an error in this case however
522 int wxSocketImpl::SendStream(const void *buffer
, int size
)
525 DO_WHILE_EINTR( ret
, send(m_fd
, static_cast<const char *>(buffer
), size
,
526 wxSOCKET_MSG_NOSIGNAL
) );
531 int wxSocketImpl::RecvDgram(void *buffer
, int size
)
533 wxSockAddressStorage from
;
534 WX_SOCKLEN_T fromlen
= sizeof(from
);
537 DO_WHILE_EINTR( ret
, recvfrom(m_fd
, static_cast<char *>(buffer
), size
,
538 0, &from
.addr
, &fromlen
) );
540 if ( ret
== SOCKET_ERROR
)
543 m_peer
= wxSockAddressImpl(from
.addr
, fromlen
);
544 if ( !m_peer
.IsOk() )
550 int wxSocketImpl::SendDgram(const void *buffer
, int size
)
552 if ( !m_peer
.IsOk() )
554 m_error
= wxSOCKET_INVADDR
;
559 DO_WHILE_EINTR( ret
, sendto(m_fd
, static_cast<const char *>(buffer
), size
,
560 0, m_peer
.GetAddr(), m_peer
.GetLen()) );
565 int wxSocketImpl::Read(void *buffer
, int size
)
567 // server sockets can't be used for IO, only to accept new connections
568 if ( m_fd
== INVALID_SOCKET
|| m_server
)
570 m_error
= wxSOCKET_INVSOCK
;
574 int ret
= m_stream
? RecvStream(buffer
, size
)
575 : RecvDgram(buffer
, size
);
577 m_error
= ret
== SOCKET_ERROR
? GetLastError() : wxSOCKET_NOERROR
;
582 int wxSocketImpl::Write(const void *buffer
, int size
)
584 if ( m_fd
== INVALID_SOCKET
|| m_server
)
586 m_error
= wxSOCKET_INVSOCK
;
590 int ret
= m_stream
? SendStream(buffer
, size
)
591 : SendDgram(buffer
, size
);
593 m_error
= ret
== SOCKET_ERROR
? GetLastError() : wxSOCKET_NOERROR
;
598 // ==========================================================================
600 // ==========================================================================
602 // --------------------------------------------------------------------------
603 // Initialization and shutdown
604 // --------------------------------------------------------------------------
606 // FIXME-MT: all this is MT-unsafe, of course, we should protect all accesses
607 // to m_countInit with a crit section
608 size_t wxSocketBase::m_countInit
= 0;
610 bool wxSocketBase::IsInitialized()
612 return m_countInit
> 0;
615 bool wxSocketBase::Initialize()
617 if ( !m_countInit
++ )
619 wxSocketManager
* const manager
= wxSocketManager::Get();
620 if ( !manager
|| !manager
->OnInit() )
631 void wxSocketBase::Shutdown()
633 // we should be initialized
634 wxASSERT_MSG( m_countInit
> 0, _T("extra call to Shutdown()") );
635 if ( --m_countInit
== 0 )
637 wxSocketManager
* const manager
= wxSocketManager::Get();
638 wxCHECK_RET( manager
, "should have a socket manager" );
644 // --------------------------------------------------------------------------
646 // --------------------------------------------------------------------------
648 void wxSocketBase::Init()
651 m_type
= wxSOCKET_UNINIT
;
662 m_beingDeleted
= false;
677 if ( !IsInitialized() )
679 // this Initialize() will be undone by wxSocketModule::OnExit(), all
680 // the other calls to it should be matched by a call to Shutdown()
685 wxSocketBase::wxSocketBase()
690 wxSocketBase::wxSocketBase(wxSocketFlags flags
, wxSocketType type
)
699 wxSocketBase::~wxSocketBase()
701 // Just in case the app called Destroy() *and* then deleted the socket
702 // immediately: don't leave dangling pointers.
703 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
705 traits
->RemoveFromPendingDelete(this);
707 // Shutdown and close the socket
711 // Destroy the implementation object
714 // Free the pushback buffer
719 bool wxSocketBase::Destroy()
721 // Delayed destruction: the socket will be deleted during the next idle
722 // loop iteration. This ensures that all pending events have been
724 m_beingDeleted
= true;
726 // Shutdown and close the socket
729 // Suppress events from now on
732 // schedule this object for deletion
733 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
736 // let the traits object decide what to do with us
737 traits
->ScheduleForDestroy(this);
739 else // no app or no traits
741 // in wxBase we might have no app object at all, don't leak memory
748 // ----------------------------------------------------------------------------
750 // ----------------------------------------------------------------------------
752 void wxSocketBase::SetError(wxSocketError error
)
754 m_impl
->m_error
= error
;
757 wxSocketError
wxSocketBase::LastError() const
759 return m_impl
->GetError();
762 // --------------------------------------------------------------------------
764 // --------------------------------------------------------------------------
766 // The following IO operations update m_lcount:
767 // {Read, Write, ReadMsg, WriteMsg, Peek, Unread, Discard}
768 bool wxSocketBase::Close()
770 // Interrupt pending waits
776 m_establishing
= false;
780 void wxSocketBase::ShutdownOutput()
786 wxSocketBase
& wxSocketBase::Read(void* buffer
, wxUint32 nbytes
)
791 m_lcount
= DoRead(buffer
, nbytes
);
793 // Allow read events from now on
799 wxUint32
wxSocketBase::DoRead(void* buffer_
, wxUint32 nbytes
)
801 wxCHECK_MSG( m_impl
, 0, "socket must be valid" );
803 // We use pointer arithmetic here which doesn't work with void pointers.
804 char *buffer
= static_cast<char *>(buffer_
);
805 wxCHECK_MSG( buffer
, 0, "NULL buffer" );
807 // Try the push back buffer first, even before checking whether the socket
808 // is valid to allow reading previously pushed back data from an already
810 wxUint32 total
= GetPushback(buffer
, nbytes
, false);
814 // we can't read anything [more] if we're not connected
820 // our socket is non-blocking so Read() will return immediately if
821 // there is nothing to read yet and it's more efficient to try it first
822 // before entering WaitForRead() which is going to start dispatching
823 // GUI events and, even more importantly, we must do this under Windows
824 // where we're not going to get notifications about socket being ready
825 // for reading before we read all the existing data from it
826 const int ret
= m_impl
->Read(buffer
, nbytes
);
829 if ( m_impl
->GetLastError() == wxSOCKET_WOULDBLOCK
)
831 // if we don't want to wait, just return immediately
832 if ( m_flags
& wxSOCKET_NOWAIT
)
835 // otherwise wait until the socket becomes ready for reading
836 if ( !WaitForRead() )
838 // and exit if the timeout elapsed before it did
839 SetError(wxSOCKET_TIMEDOUT
);
848 SetError(wxSOCKET_IOERR
);
854 // for connection-oriented (e.g. TCP) sockets we can only read
855 // 0 bytes if the other end has been closed, and for connectionless
856 // ones (UDP) this flag doesn't make sense anyhow so we can set it
857 // to true too without doing any harm
860 // we're not going to read anything else and so if we haven't read
861 // anything (or not everything in wxSOCKET_WAITALL case) already,
863 if ( (m_flags
& wxSOCKET_WAITALL
) || !total
)
864 SetError(wxSOCKET_IOERR
);
870 // if we are happy to read something and not the entire nbytes bytes,
872 if ( !(m_flags
& wxSOCKET_WAITALL
) )
882 wxSocketBase
& wxSocketBase::ReadMsg(void* buffer
, wxUint32 nbytes
)
886 unsigned char sig
[4];
887 unsigned char len
[4];
893 int old_flags
= m_flags
;
894 SetFlags((m_flags
& wxSOCKET_BLOCK
) | wxSOCKET_WAITALL
);
897 if ( DoRead(&msg
, sizeof(msg
)) == sizeof(msg
) )
899 wxUint32 sig
= (wxUint32
)msg
.sig
[0];
900 sig
|= (wxUint32
)(msg
.sig
[1] << 8);
901 sig
|= (wxUint32
)(msg
.sig
[2] << 16);
902 sig
|= (wxUint32
)(msg
.sig
[3] << 24);
904 if ( sig
== 0xfeeddead )
906 wxUint32 len
= (wxUint32
)msg
.len
[0];
907 len
|= (wxUint32
)(msg
.len
[1] << 8);
908 len
|= (wxUint32
)(msg
.len
[2] << 16);
909 len
|= (wxUint32
)(msg
.len
[3] << 24);
920 // Don't attempt to read if the msg was zero bytes long.
921 m_lcount
= len
? DoRead(buffer
, len
) : 0;
925 char discard_buffer
[MAX_DISCARD_SIZE
];
928 // NOTE: discarded bytes don't add to m_lcount.
931 discard_len
= len2
> MAX_DISCARD_SIZE
934 discard_len
= DoRead(discard_buffer
, (wxUint32
)discard_len
);
935 len2
-= (wxUint32
)discard_len
;
937 while ((discard_len
> 0) && len2
);
940 if ( !len2
&& DoRead(&msg
, sizeof(msg
)) == sizeof(msg
) )
942 sig
= (wxUint32
)msg
.sig
[0];
943 sig
|= (wxUint32
)(msg
.sig
[1] << 8);
944 sig
|= (wxUint32
)(msg
.sig
[2] << 16);
945 sig
|= (wxUint32
)(msg
.sig
[3] << 24);
947 if ( sig
== 0xdeadfeed )
954 SetError(wxSOCKET_IOERR
);
962 wxSocketBase
& wxSocketBase::Peek(void* buffer
, wxUint32 nbytes
)
967 m_lcount
= DoRead(buffer
, nbytes
);
968 Pushback(buffer
, m_lcount
);
970 // Allow read events again
976 wxSocketBase
& wxSocketBase::Write(const void *buffer
, wxUint32 nbytes
)
981 m_lcount
= DoWrite(buffer
, nbytes
);
983 // Allow write events again
989 // This function is a mirror image of DoRead() except that it doesn't use the
990 // push back buffer and doesn't treat 0 return value specially (normally this
991 // shouldn't happen at all here), so please see comments there for explanations
992 wxUint32
wxSocketBase::DoWrite(const void *buffer_
, wxUint32 nbytes
)
994 wxCHECK_MSG( m_impl
, 0, "socket must be valid" );
996 const char *buffer
= static_cast<const char *>(buffer_
);
997 wxCHECK_MSG( buffer
, 0, "NULL buffer" );
1005 const int ret
= m_impl
->Write(buffer
, nbytes
);
1008 if ( m_impl
->GetLastError() == wxSOCKET_WOULDBLOCK
)
1010 if ( m_flags
& wxSOCKET_NOWAIT
)
1013 if ( !WaitForWrite() )
1015 SetError(wxSOCKET_TIMEDOUT
);
1021 else // "real" error
1023 SetError(wxSOCKET_IOERR
);
1030 if ( !(m_flags
& wxSOCKET_WAITALL
) )
1040 wxSocketBase
& wxSocketBase::WriteMsg(const void *buffer
, wxUint32 nbytes
)
1044 unsigned char sig
[4];
1045 unsigned char len
[4];
1048 // Mask write events
1051 const int old_flags
= m_flags
;
1052 SetFlags((m_flags
& wxSOCKET_BLOCK
) | wxSOCKET_WAITALL
);
1054 msg
.sig
[0] = (unsigned char) 0xad;
1055 msg
.sig
[1] = (unsigned char) 0xde;
1056 msg
.sig
[2] = (unsigned char) 0xed;
1057 msg
.sig
[3] = (unsigned char) 0xfe;
1059 msg
.len
[0] = (unsigned char) (nbytes
& 0xff);
1060 msg
.len
[1] = (unsigned char) ((nbytes
>> 8) & 0xff);
1061 msg
.len
[2] = (unsigned char) ((nbytes
>> 16) & 0xff);
1062 msg
.len
[3] = (unsigned char) ((nbytes
>> 24) & 0xff);
1065 if ( DoWrite(&msg
, sizeof(msg
)) == sizeof(msg
) )
1067 m_lcount
= DoWrite(buffer
, nbytes
);
1068 if ( m_lcount
== nbytes
)
1070 msg
.sig
[0] = (unsigned char) 0xed;
1071 msg
.sig
[1] = (unsigned char) 0xfe;
1072 msg
.sig
[2] = (unsigned char) 0xad;
1073 msg
.sig
[3] = (unsigned char) 0xde;
1077 msg
.len
[3] = (char) 0;
1079 if ( DoWrite(&msg
, sizeof(msg
)) == sizeof(msg
))
1085 SetError(wxSOCKET_IOERR
);
1088 SetFlags(old_flags
);
1093 wxSocketBase
& wxSocketBase::Unread(const void *buffer
, wxUint32 nbytes
)
1096 Pushback(buffer
, nbytes
);
1098 SetError(wxSOCKET_NOERROR
);
1104 wxSocketBase
& wxSocketBase::Discard()
1106 char *buffer
= new char[MAX_DISCARD_SIZE
];
1113 const int old_flags
= m_flags
;
1114 SetFlags(wxSOCKET_NOWAIT
);
1118 ret
= DoRead(buffer
, MAX_DISCARD_SIZE
);
1121 while (ret
== MAX_DISCARD_SIZE
);
1125 SetError(wxSOCKET_NOERROR
);
1127 // Allow read events again
1130 SetFlags(old_flags
);
1135 // --------------------------------------------------------------------------
1137 // --------------------------------------------------------------------------
1140 This function will check for the events specified in the flags parameter,
1141 and it will return a mask indicating which operations can be performed.
1143 wxSocketEventFlags
wxSocketImpl::Select(wxSocketEventFlags flags
,
1144 const timeval
*timeout
)
1146 if ( m_fd
== INVALID_SOCKET
)
1147 return (wxSOCKET_LOST_FLAG
& flags
);
1153 tv
.tv_sec
= tv
.tv_usec
= 0;
1155 // prepare the FD sets, passing NULL for the one(s) we don't use
1157 readfds
, *preadfds
= NULL
,
1158 writefds
, *pwritefds
= NULL
,
1159 exceptfds
; // always want to know about errors
1161 if ( flags
& wxSOCKET_INPUT_FLAG
)
1163 preadfds
= &readfds
;
1164 wxFD_ZERO(preadfds
);
1165 wxFD_SET(m_fd
, preadfds
);
1168 // when using non-blocking connect() the socket becomes connected
1169 // (successfully or not) when it becomes writable
1170 if ( flags
& (wxSOCKET_OUTPUT_FLAG
| wxSOCKET_CONNECTION_FLAG
) )
1172 pwritefds
= &writefds
;
1173 wxFD_ZERO(pwritefds
);
1174 wxFD_SET(m_fd
, pwritefds
);
1177 wxFD_ZERO(&exceptfds
);
1178 wxFD_SET(m_fd
, &exceptfds
);
1180 const int rc
= select(m_fd
+ 1, preadfds
, pwritefds
, &exceptfds
, &tv
);
1182 // check for errors first
1183 if ( rc
== -1 || wxFD_ISSET(m_fd
, &exceptfds
) )
1185 m_establishing
= false;
1187 return wxSOCKET_LOST_FLAG
& flags
;
1193 wxASSERT_MSG( rc
== 1, "unexpected select() return value" );
1195 wxSocketEventFlags detected
= 0;
1196 if ( preadfds
&& wxFD_ISSET(m_fd
, preadfds
) )
1197 detected
|= wxSOCKET_INPUT_FLAG
;
1199 if ( pwritefds
&& wxFD_ISSET(m_fd
, pwritefds
) )
1201 // check for the case of non-blocking connect()
1202 if ( m_establishing
&& !m_server
)
1205 SOCKOPTLEN_T len
= sizeof(error
);
1206 m_establishing
= false;
1207 getsockopt(m_fd
, SOL_SOCKET
, SO_ERROR
, (char*)&error
, &len
);
1210 detected
= wxSOCKET_LOST_FLAG
;
1212 detected
|= wxSOCKET_CONNECTION_FLAG
;
1214 else // not called to get non-blocking connect() status
1216 detected
|= wxSOCKET_OUTPUT_FLAG
;
1220 return detected
& flags
;
1224 wxSocketBase::DoWait(long seconds
, long milliseconds
, wxSocketEventFlags flags
)
1226 wxCHECK_MSG( m_impl
, false, "can't wait on invalid socket" );
1228 // we're never going to become ready if we're not connected (any more)
1229 if ( !m_connected
&& !m_establishing
)
1230 return (flags
& wxSOCKET_LOST_FLAG
) != 0;
1232 // This can be set to true from Interrupt() to exit this function a.s.a.p.
1233 m_interrupt
= false;
1236 // Use either the provided timeout or the default timeout value associated
1237 // with this socket.
1239 // TODO: allow waiting forever, see #9443
1240 const long timeout
= seconds
== -1 ? m_timeout
* 1000
1241 : seconds
* 1000 + milliseconds
;
1242 const wxMilliClock_t timeEnd
= wxGetLocalTimeMillis() + timeout
;
1244 // Get the active event loop which we'll use for the message dispatching
1245 // when running in the main thread unless this was explicitly disabled by
1246 // setting wxSOCKET_BLOCK flag
1247 wxEventLoopBase
*eventLoop
;
1248 if ( !(m_flags
& wxSOCKET_BLOCK
) && wxIsMainThread() )
1250 eventLoop
= wxEventLoop::GetActive();
1252 else // in worker thread
1254 // We never dispatch messages from threads other than the main one.
1258 // Wait until we receive the event we're waiting for or the timeout expires
1259 // (but note that we always execute the loop at least once, even if timeout
1260 // is 0 as this is used for polling)
1261 bool gotEvent
= false;
1262 for ( bool firstTime
= true; !m_interrupt
; firstTime
= false )
1264 long timeLeft
= wxMilliClockToLong(timeEnd
- wxGetLocalTimeMillis());
1273 wxSocketEventFlags events
;
1276 // reset them before starting to wait
1279 eventLoop
->DispatchTimeout(timeLeft
);
1281 events
= m_eventsgot
;
1283 else // no event loop or waiting in another thread
1285 // as explained below, we should always check for wxSOCKET_LOST_FLAG
1287 SetTimeValFromMS(tv
, timeLeft
);
1288 events
= m_impl
->Select(flags
| wxSOCKET_LOST_FLAG
, &tv
);
1291 // always check for wxSOCKET_LOST_FLAG, even if flags doesn't include
1292 // it, as continuing to wait for anything else after getting it is
1294 if ( events
& wxSOCKET_LOST_FLAG
)
1296 m_connected
= false;
1297 m_establishing
= false;
1298 if ( flags
& wxSOCKET_LOST_FLAG
)
1303 // otherwise mask out the bits we're not interested in
1306 // Incoming connection (server) or connection established (client)?
1307 if ( events
& wxSOCKET_CONNECTION_FLAG
)
1310 m_establishing
= false;
1315 // Data available or output buffer ready?
1316 if ( (events
& wxSOCKET_INPUT_FLAG
) || (events
& wxSOCKET_OUTPUT_FLAG
) )
1326 bool wxSocketBase::Wait(long seconds
, long milliseconds
)
1328 return DoWait(seconds
, milliseconds
,
1329 wxSOCKET_INPUT_FLAG
|
1330 wxSOCKET_OUTPUT_FLAG
|
1331 wxSOCKET_CONNECTION_FLAG
|
1336 bool wxSocketBase::WaitForRead(long seconds
, long milliseconds
)
1338 // Check pushback buffer before entering DoWait
1342 // Note that wxSOCKET_INPUT_LOST has to be explicitly passed to DoWait
1343 // because of the semantics of WaitForRead: a return value of true means
1344 // that a Read call will return immediately, not that there is
1345 // actually data to read.
1346 return DoWait(seconds
, milliseconds
, wxSOCKET_INPUT_FLAG
| wxSOCKET_LOST_FLAG
);
1350 bool wxSocketBase::WaitForWrite(long seconds
, long milliseconds
)
1352 return DoWait(seconds
, milliseconds
, wxSOCKET_OUTPUT_FLAG
| wxSOCKET_LOST_FLAG
);
1355 bool wxSocketBase::WaitForLost(long seconds
, long milliseconds
)
1357 return DoWait(seconds
, milliseconds
, wxSOCKET_LOST_FLAG
);
1360 // --------------------------------------------------------------------------
1362 // --------------------------------------------------------------------------
1365 // Get local or peer address
1368 bool wxSocketBase::GetPeer(wxSockAddress
& addr
) const
1370 wxCHECK_MSG( m_impl
, false, "invalid socket" );
1372 const wxSockAddressImpl
& peer
= m_impl
->GetPeer();
1376 addr
.SetAddress(peer
);
1381 bool wxSocketBase::GetLocal(wxSockAddress
& addr
) const
1383 wxCHECK_MSG( m_impl
, false, "invalid socket" );
1385 const wxSockAddressImpl
& local
= m_impl
->GetLocal();
1386 if ( !local
.IsOk() )
1389 addr
.SetAddress(local
);
1395 // Save and restore socket state
1398 void wxSocketBase::SaveState()
1400 wxSocketState
*state
;
1402 state
= new wxSocketState();
1404 state
->m_flags
= m_flags
;
1405 state
->m_notify
= m_notify
;
1406 state
->m_eventmask
= m_eventmask
;
1407 state
->m_clientData
= m_clientData
;
1409 m_states
.Append(state
);
1412 void wxSocketBase::RestoreState()
1414 wxList::compatibility_iterator node
;
1415 wxSocketState
*state
;
1417 node
= m_states
.GetLast();
1421 state
= (wxSocketState
*)node
->GetData();
1423 m_flags
= state
->m_flags
;
1424 m_notify
= state
->m_notify
;
1425 m_eventmask
= state
->m_eventmask
;
1426 m_clientData
= state
->m_clientData
;
1428 m_states
.Erase(node
);
1433 // Timeout and flags
1436 void wxSocketBase::SetTimeout(long seconds
)
1438 m_timeout
= seconds
;
1441 m_impl
->SetTimeout(m_timeout
* 1000);
1444 void wxSocketBase::SetFlags(wxSocketFlags flags
)
1446 // Do some sanity checking on the flags used: not all values can be used
1448 wxASSERT_MSG( !(flags
& wxSOCKET_NOWAIT
) ||
1449 !(flags
& (wxSOCKET_WAITALL
| wxSOCKET_BLOCK
)),
1450 "Using wxSOCKET_WAITALL or wxSOCKET_BLOCK with "
1451 "wxSOCKET_NOWAIT doesn't make sense" );
1457 // --------------------------------------------------------------------------
1459 // --------------------------------------------------------------------------
1461 void wxSocketBase::OnRequest(wxSocketNotify notification
)
1463 wxSocketEventFlags flag
= 0;
1464 switch ( notification
)
1466 case wxSOCKET_INPUT
:
1467 flag
= wxSOCKET_INPUT_FLAG
;
1470 case wxSOCKET_OUTPUT
:
1471 flag
= wxSOCKET_OUTPUT_FLAG
;
1474 case wxSOCKET_CONNECTION
:
1475 flag
= wxSOCKET_CONNECTION_FLAG
;
1479 flag
= wxSOCKET_LOST_FLAG
;
1483 wxFAIL_MSG( "unknown wxSocket notification" );
1486 // if we lost the connection the socket is now closed
1487 if ( notification
== wxSOCKET_LOST
)
1490 // remember the events which were generated for this socket, we're going to
1491 // use this in DoWait()
1492 m_eventsgot
|= flag
;
1494 // send the wx event if enabled and we're interested in it
1495 if ( m_notify
&& (m_eventmask
& flag
) && m_handler
)
1497 // If we are in the middle of a R/W operation, do not propagate events
1498 // to users. Also, filter 'late' events which are no longer valid.
1499 if ( notification
== wxSOCKET_INPUT
)
1501 if ( m_reading
|| !m_impl
->Select(wxSOCKET_INPUT_FLAG
) )
1504 else if ( notification
== wxSOCKET_OUTPUT
)
1506 if ( m_writing
|| !m_impl
->Select(wxSOCKET_OUTPUT_FLAG
) )
1510 wxSocketEvent
event(m_id
);
1511 event
.m_event
= notification
;
1512 event
.m_clientData
= m_clientData
;
1513 event
.SetEventObject(this);
1515 m_handler
->AddPendingEvent(event
);
1519 void wxSocketBase::Notify(bool notify
)
1524 void wxSocketBase::SetNotify(wxSocketEventFlags flags
)
1526 m_eventmask
= flags
;
1529 void wxSocketBase::SetEventHandler(wxEvtHandler
& handler
, int id
)
1531 m_handler
= &handler
;
1535 // --------------------------------------------------------------------------
1537 // --------------------------------------------------------------------------
1539 void wxSocketBase::Pushback(const void *buffer
, wxUint32 size
)
1543 if (m_unread
== NULL
)
1544 m_unread
= malloc(size
);
1549 tmp
= malloc(m_unrd_size
+ size
);
1550 memcpy((char *)tmp
+ size
, m_unread
, m_unrd_size
);
1556 m_unrd_size
+= size
;
1558 memcpy(m_unread
, buffer
, size
);
1561 wxUint32
wxSocketBase::GetPushback(void *buffer
, wxUint32 size
, bool peek
)
1563 wxCHECK_MSG( buffer
, 0, "NULL buffer" );
1568 if (size
> (m_unrd_size
-m_unrd_cur
))
1569 size
= m_unrd_size
-m_unrd_cur
;
1571 memcpy(buffer
, (char *)m_unread
+ m_unrd_cur
, size
);
1576 if (m_unrd_size
== m_unrd_cur
)
1589 // ==========================================================================
1591 // ==========================================================================
1593 // --------------------------------------------------------------------------
1595 // --------------------------------------------------------------------------
1597 wxSocketServer::wxSocketServer(const wxSockAddress
& addr
,
1598 wxSocketFlags flags
)
1599 : wxSocketBase(flags
, wxSOCKET_SERVER
)
1601 wxLogTrace( wxTRACE_Socket
, _T("Opening wxSocketServer") );
1603 m_impl
= wxSocketImpl::Create(*this);
1607 wxLogTrace( wxTRACE_Socket
, _T("*** Failed to create m_impl") );
1611 // Setup the socket as server
1612 m_impl
->SetLocal(addr
.GetAddress());
1614 if (GetFlags() & wxSOCKET_REUSEADDR
) {
1615 m_impl
->SetReusable();
1617 if (GetFlags() & wxSOCKET_BROADCAST
) {
1618 m_impl
->SetBroadcast();
1620 if (GetFlags() & wxSOCKET_NOBIND
) {
1621 m_impl
->DontDoBind();
1624 if (m_impl
->CreateServer() != wxSOCKET_NOERROR
)
1629 wxLogTrace( wxTRACE_Socket
, _T("*** CreateServer() failed") );
1633 wxLogTrace( wxTRACE_Socket
, _T("wxSocketServer on fd %d"), m_impl
->m_fd
);
1636 // --------------------------------------------------------------------------
1638 // --------------------------------------------------------------------------
1640 bool wxSocketServer::AcceptWith(wxSocketBase
& sock
, bool wait
)
1642 if ( !m_impl
|| (m_impl
->m_fd
== INVALID_SOCKET
) || !m_impl
->IsServer() )
1644 wxFAIL_MSG( "can only be called for a valid server socket" );
1646 SetError(wxSOCKET_INVSOCK
);
1653 // wait until we get a connection
1654 if ( !m_impl
->SelectWithTimeout(wxSOCKET_INPUT_FLAG
) )
1656 SetError(wxSOCKET_TIMEDOUT
);
1662 sock
.m_impl
= m_impl
->Accept(sock
);
1666 SetError(m_impl
->GetLastError());
1671 sock
.m_type
= wxSOCKET_BASE
;
1672 sock
.m_connected
= true;
1677 wxSocketBase
*wxSocketServer::Accept(bool wait
)
1679 wxSocketBase
* sock
= new wxSocketBase();
1681 sock
->SetFlags(m_flags
);
1683 if (!AcceptWith(*sock
, wait
))
1692 bool wxSocketServer::WaitForAccept(long seconds
, long milliseconds
)
1694 return DoWait(seconds
, milliseconds
, wxSOCKET_CONNECTION_FLAG
);
1697 bool wxSocketBase::GetOption(int level
, int optname
, void *optval
, int *optlen
)
1699 wxASSERT_MSG( m_impl
, _T("Socket not initialised") );
1701 SOCKOPTLEN_T lenreal
= *optlen
;
1702 if ( getsockopt(m_impl
->m_fd
, level
, optname
,
1703 static_cast<char *>(optval
), &lenreal
) != 0 )
1712 wxSocketBase::SetOption(int level
, int optname
, const void *optval
, int optlen
)
1714 wxASSERT_MSG( m_impl
, _T("Socket not initialised") );
1716 return setsockopt(m_impl
->m_fd
, level
, optname
,
1717 static_cast<const char *>(optval
), optlen
) == 0;
1720 bool wxSocketBase::SetLocal(const wxIPV4address
& local
)
1722 m_localAddress
= local
;
1727 // ==========================================================================
1729 // ==========================================================================
1731 // --------------------------------------------------------------------------
1733 // --------------------------------------------------------------------------
1735 wxSocketClient::wxSocketClient(wxSocketFlags flags
)
1736 : wxSocketBase(flags
, wxSOCKET_CLIENT
)
1738 m_initialRecvBufferSize
=
1739 m_initialSendBufferSize
= -1;
1742 wxSocketClient::~wxSocketClient()
1746 // --------------------------------------------------------------------------
1748 // --------------------------------------------------------------------------
1750 bool wxSocketClient::DoConnect(const wxSockAddress
& remote
,
1751 const wxSockAddress
* local
,
1756 // Shutdown and destroy the old socket
1761 m_connected
= false;
1762 m_establishing
= false;
1764 // Create and set up the new one
1765 m_impl
= wxSocketImpl::Create(*this);
1769 // Reuse makes sense for clients too, if we are trying to rebind to the same port
1770 if (GetFlags() & wxSOCKET_REUSEADDR
)
1771 m_impl
->SetReusable();
1772 if (GetFlags() & wxSOCKET_BROADCAST
)
1773 m_impl
->SetBroadcast();
1774 if (GetFlags() & wxSOCKET_NOBIND
)
1775 m_impl
->DontDoBind();
1777 // Bind to the local IP address and port, when provided or if one had been
1779 if ( !local
&& m_localAddress
.GetAddress().IsOk() )
1780 local
= &m_localAddress
;
1783 m_impl
->SetLocal(local
->GetAddress());
1785 m_impl
->SetInitialSocketBuffers(m_initialRecvBufferSize
, m_initialSendBufferSize
);
1787 m_impl
->SetPeer(remote
.GetAddress());
1789 // Finally do create the socket and connect to the peer
1790 const wxSocketError err
= m_impl
->CreateClient(wait
);
1792 if ( err
!= wxSOCKET_NOERROR
)
1794 if ( err
== wxSOCKET_WOULDBLOCK
)
1796 wxASSERT_MSG( !wait
, "shouldn't get this for blocking connect" );
1798 m_establishing
= true;
1808 bool wxSocketClient::Connect(const wxSockAddress
& remote
, bool wait
)
1810 return DoConnect(remote
, NULL
, wait
);
1813 bool wxSocketClient::Connect(const wxSockAddress
& remote
,
1814 const wxSockAddress
& local
,
1817 return DoConnect(remote
, &local
, wait
);
1820 bool wxSocketClient::WaitOnConnect(long seconds
, long milliseconds
)
1824 // this happens if the initial attempt to connect succeeded without
1829 wxCHECK_MSG( m_establishing
&& m_impl
, false,
1830 "No connection establishment attempt in progress" );
1832 // we must specify wxSOCKET_LOST_FLAG here explicitly because we must return
1833 // true if the connection establishment process is finished, whether it is
1834 // over because we successfully connected or because we were not able to
1836 return DoWait(seconds
, milliseconds
,
1837 wxSOCKET_CONNECTION_FLAG
| wxSOCKET_LOST_FLAG
);
1840 // ==========================================================================
1842 // ==========================================================================
1844 wxDatagramSocket::wxDatagramSocket( const wxSockAddress
& addr
,
1845 wxSocketFlags flags
)
1846 : wxSocketBase( flags
, wxSOCKET_DATAGRAM
)
1848 // Create the socket
1849 m_impl
= wxSocketImpl::Create(*this);
1854 // Setup the socket as non connection oriented
1855 m_impl
->SetLocal(addr
.GetAddress());
1856 if (flags
& wxSOCKET_REUSEADDR
)
1858 m_impl
->SetReusable();
1860 if (GetFlags() & wxSOCKET_BROADCAST
)
1862 m_impl
->SetBroadcast();
1864 if (GetFlags() & wxSOCKET_NOBIND
)
1866 m_impl
->DontDoBind();
1869 if ( m_impl
->CreateUDP() != wxSOCKET_NOERROR
)
1876 // Initialize all stuff
1877 m_connected
= false;
1878 m_establishing
= false;
1881 wxDatagramSocket
& wxDatagramSocket::RecvFrom( wxSockAddress
& addr
,
1890 wxDatagramSocket
& wxDatagramSocket::SendTo( const wxSockAddress
& addr
,
1894 wxASSERT_MSG( m_impl
, _T("Socket not initialised") );
1896 m_impl
->SetPeer(addr
.GetAddress());
1901 // ==========================================================================
1903 // ==========================================================================
1905 class wxSocketModule
: public wxModule
1908 virtual bool OnInit()
1910 // wxSocketBase will call Initialize() itself only if sockets are
1911 // really used, don't do it from here
1915 virtual void OnExit()
1917 if ( wxSocketBase::IsInitialized() )
1918 wxSocketBase::Shutdown();
1922 DECLARE_DYNAMIC_CLASS(wxSocketModule
)
1925 IMPLEMENT_DYNAMIC_CLASS(wxSocketModule
, wxModule
)
1927 #endif // wxUSE_SOCKETS