]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/msw/sockmsw.cpp
Several corrections to wxDocManager fields documentation.
[wxWidgets.git] / src / msw / sockmsw.cpp
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: src/msw/sockmsw.cpp
3// Purpose: MSW-specific socket code
4// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
5// Created: April 1997
6// Copyright: (C) 1999-1997, Guilhem Lavaux
7// (C) 1999-2000, Guillermo Rodriguez Garcia
8// (C) 2008 Vadim Zeitlin
9// RCS_ID: $Id$
10// Licence: wxWindows licence
11/////////////////////////////////////////////////////////////////////////////
12
13
14// For compilers that support precompilation, includes "wx.h".
15#include "wx/wxprec.h"
16
17#ifdef __BORLANDC__
18 #pragma hdrstop
19#endif
20
21#if wxUSE_SOCKETS
22
23/* including rasasync.h (included from windows.h itself included from
24 * wx/setup.h and/or winsock.h results in this warning for
25 * RPCNOTIFICATION_ROUTINE
26 */
27#ifdef _MSC_VER
28# pragma warning(disable:4115) /* named type definition in parentheses */
29#endif
30
31#include "wx/private/socket.h"
32#include "wx/msw/private.h" // for wxGetInstance()
33#include "wx/private/fd.h"
34#include "wx/apptrait.h"
35#include "wx/thread.h"
36#include "wx/dynlib.h"
37#include "wx/link.h"
38
39#ifdef __WXWINCE__
40/*
41 * As WSAAsyncSelect is not present on WinCE, it now uses WSACreateEvent,
42 * WSAEventSelect, WSAWaitForMultipleEvents and WSAEnumNetworkEvents. When
43 * enabling eventhandling for a socket a new thread it created that keeps track
44 * of the events and posts a messageto the hidden window to use the standard
45 * message loop.
46 */
47#include "wx/msw/wince/net.h"
48#include "wx/hashmap.h"
49WX_DECLARE_HASH_MAP(int,bool,wxIntegerHash,wxIntegerEqual,SocketHash);
50
51#ifndef isdigit
52#define isdigit(x) (x > 47 && x < 58)
53#endif
54#include "wx/msw/wince/net.h"
55
56#endif // __WXWINCE__
57
58#ifdef _MSC_VER
59# pragma warning(default:4115) /* named type definition in parentheses */
60#endif
61
62#define CLASSNAME TEXT("_wxSocket_Internal_Window_Class")
63
64/* implemented in utils.cpp */
65extern "C" WXDLLIMPEXP_BASE HWND
66wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
67
68/* Maximum number of different wxSocket objects at a given time.
69 * This value can be modified at will, but it CANNOT be greater
70 * than (0x7FFF - WM_USER + 1)
71 */
72#define MAXSOCKETS 1024
73
74#if (MAXSOCKETS > (0x7FFF - WM_USER + 1))
75#error "MAXSOCKETS is too big!"
76#endif
77
78#ifndef __WXWINCE__
79typedef int (PASCAL *WSAAsyncSelect_t)(SOCKET,HWND,u_int,long);
80#else
81/* Typedef the needed function prototypes and the WSANETWORKEVENTS structure
82*/
83typedef struct _WSANETWORKEVENTS {
84 long lNetworkEvents;
85 int iErrorCode[10];
86} WSANETWORKEVENTS, FAR * LPWSANETWORKEVENTS;
87typedef HANDLE (PASCAL *WSACreateEvent_t)();
88typedef int (PASCAL *WSAEventSelect_t)(SOCKET,HANDLE,long);
89typedef int (PASCAL *WSAWaitForMultipleEvents_t)(long,HANDLE,BOOL,long,BOOL);
90typedef int (PASCAL *WSAEnumNetworkEvents_t)(SOCKET,HANDLE,LPWSANETWORKEVENTS);
91#endif //__WXWINCE__
92
93LRESULT CALLBACK wxSocket_Internal_WinProc(HWND, UINT, WPARAM, LPARAM);
94
95/* Global variables */
96
97static HWND hWin;
98wxCRIT_SECT_DECLARE_MEMBER(gs_critical);
99static wxSocketImplMSW *socketList[MAXSOCKETS];
100static int firstAvailable;
101
102#ifndef __WXWINCE__
103static WSAAsyncSelect_t gs_WSAAsyncSelect = NULL;
104#else
105static SocketHash socketHash;
106static unsigned int currSocket;
107HANDLE hThread[MAXSOCKETS];
108static WSACreateEvent_t gs_WSACreateEvent = NULL;
109static WSAEventSelect_t gs_WSAEventSelect = NULL;
110static WSAWaitForMultipleEvents_t gs_WSAWaitForMultipleEvents = NULL;
111static WSAEnumNetworkEvents_t gs_WSAEnumNetworkEvents = NULL;
112/* This structure will be used to pass data on to the thread that handles socket events.
113*/
114typedef struct thread_data{
115 HWND hEvtWin;
116 unsigned long msgnumber;
117 unsigned long fd;
118 unsigned long lEvent;
119}thread_data;
120#endif
121
122#ifdef __WXWINCE__
123/* This thread handles socket events on WinCE using WSAEventSelect() as
124 * WSAAsyncSelect is not supported. When an event occurs for the socket, it is
125 * checked what kind of event happend and the correct message gets posted so
126 * that the hidden window can handle it as it would in other MSW builds.
127*/
128DWORD WINAPI SocketThread(LPVOID data)
129{
130 WSANETWORKEVENTS NetworkEvents;
131 thread_data* d = (thread_data *)data;
132
133 HANDLE NetworkEvent = gs_WSACreateEvent();
134 gs_WSAEventSelect(d->fd, NetworkEvent, d->lEvent);
135
136 while(socketHash[d->fd] == true)
137 {
138 if ((gs_WSAWaitForMultipleEvents(1, &NetworkEvent, FALSE,INFINITE, FALSE)) == WAIT_FAILED)
139 {
140 printf("WSAWaitForMultipleEvents failed with error %d\n", WSAGetLastError());
141 return 0;
142 }
143 if (gs_WSAEnumNetworkEvents(d->fd ,NetworkEvent, &NetworkEvents) == SOCKET_ERROR)
144 {
145 printf("WSAEnumNetworkEvents failed with error %d\n", WSAGetLastError());
146 return 0;
147 }
148
149 long flags = NetworkEvents.lNetworkEvents;
150 if (flags & FD_READ)
151 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_READ);
152 if (flags & FD_WRITE)
153 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_WRITE);
154 if (flags & FD_OOB)
155 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_OOB);
156 if (flags & FD_ACCEPT)
157 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_ACCEPT);
158 if (flags & FD_CONNECT)
159 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CONNECT);
160 if (flags & FD_CLOSE)
161 ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CLOSE);
162
163 }
164 gs_WSAEventSelect(d->fd, NetworkEvent, 0);
165 ExitThread(0);
166 return 0;
167}
168#endif
169
170// ----------------------------------------------------------------------------
171// MSW implementation of wxSocketManager
172// ----------------------------------------------------------------------------
173
174class wxSocketMSWManager : public wxSocketManager
175{
176public:
177 virtual bool OnInit();
178 virtual void OnExit();
179
180 virtual wxSocketImpl *CreateSocket(wxSocketBase& wxsocket)
181 {
182 return new wxSocketImplMSW(wxsocket);
183 }
184 virtual void Install_Callback(wxSocketImpl *socket,
185 wxSocketNotify event = wxSOCKET_LOST);
186 virtual void Uninstall_Callback(wxSocketImpl *socket,
187 wxSocketNotify event = wxSOCKET_LOST);
188
189private:
190 static wxDynamicLibrary gs_wsock32dll;
191};
192
193wxDynamicLibrary wxSocketMSWManager::gs_wsock32dll;
194
195bool wxSocketMSWManager::OnInit()
196{
197 static LPCTSTR pclassname = NULL;
198 int i;
199
200 /* Create internal window for event notifications */
201 hWin = wxCreateHiddenWindow(&pclassname, CLASSNAME, wxSocket_Internal_WinProc);
202 if (!hWin)
203 return false;
204
205 /* Initialize socket list */
206 for (i = 0; i < MAXSOCKETS; i++)
207 {
208 socketList[i] = NULL;
209 }
210 firstAvailable = 0;
211
212 // we don't link with wsock32.dll (or ws2 in CE case) statically to avoid
213 // dependencies on it for all the application using wx even if they don't use
214 // sockets
215#ifdef __WXWINCE__
216 #define WINSOCK_DLL_NAME wxT("ws2.dll")
217#else
218 #define WINSOCK_DLL_NAME wxT("wsock32.dll")
219#endif
220
221 gs_wsock32dll.Load(WINSOCK_DLL_NAME, wxDL_VERBATIM | wxDL_QUIET);
222 if ( !gs_wsock32dll.IsLoaded() )
223 return false;
224
225#ifndef __WXWINCE__
226 wxDL_INIT_FUNC(gs_, WSAAsyncSelect, gs_wsock32dll);
227 if ( !gs_WSAAsyncSelect )
228 return false;
229#else
230 wxDL_INIT_FUNC(gs_, WSAEventSelect, gs_wsock32dll);
231 if ( !gs_WSAEventSelect )
232 return false;
233
234 wxDL_INIT_FUNC(gs_, WSACreateEvent, gs_wsock32dll);
235 if ( !gs_WSACreateEvent )
236 return false;
237
238 wxDL_INIT_FUNC(gs_, WSAWaitForMultipleEvents, gs_wsock32dll);
239 if ( !gs_WSAWaitForMultipleEvents )
240 return false;
241
242 wxDL_INIT_FUNC(gs_, WSAEnumNetworkEvents, gs_wsock32dll);
243 if ( !gs_WSAEnumNetworkEvents )
244 return false;
245
246 currSocket = 0;
247#endif // !__WXWINCE__/__WXWINCE__
248
249 // finally initialize WinSock
250 WSADATA wsaData;
251 return WSAStartup((1 << 8) | 1, &wsaData) == 0;
252}
253
254void wxSocketMSWManager::OnExit()
255{
256#ifdef __WXWINCE__
257/* Delete the threads here */
258 for(unsigned int i=0; i < currSocket; i++)
259 CloseHandle(hThread[i]);
260#endif
261 /* Destroy internal window */
262 DestroyWindow(hWin);
263 UnregisterClass(CLASSNAME, wxGetInstance());
264
265 WSACleanup();
266
267 gs_wsock32dll.Unload();
268}
269
270/* Per-socket GUI initialization / cleanup */
271
272wxSocketImplMSW::wxSocketImplMSW(wxSocketBase& wxsocket)
273 : wxSocketImpl(wxsocket)
274{
275 /* Allocate a new message number for this socket */
276 wxCRIT_SECT_LOCKER(lock, gs_critical);
277
278 int i = firstAvailable;
279 while (socketList[i] != NULL)
280 {
281 i = (i + 1) % MAXSOCKETS;
282
283 if (i == firstAvailable) /* abort! */
284 {
285 m_msgnumber = 0; // invalid
286 return;
287 }
288 }
289 socketList[i] = this;
290 firstAvailable = (i + 1) % MAXSOCKETS;
291 m_msgnumber = (i + WM_USER);
292}
293
294wxSocketImplMSW::~wxSocketImplMSW()
295{
296 /* Remove the socket from the list */
297 wxCRIT_SECT_LOCKER(lock, gs_critical);
298
299 if ( m_msgnumber )
300 {
301 // we need to remove any pending messages for this socket to avoid having
302 // them sent to a new socket which could reuse the same message number as
303 // soon as we destroy this one
304 MSG msg;
305 while ( ::PeekMessage(&msg, hWin, m_msgnumber, m_msgnumber, PM_REMOVE) )
306 ;
307
308 socketList[m_msgnumber - WM_USER] = NULL;
309 }
310 //else: the socket has never been created successfully
311}
312
313/* Windows proc for asynchronous event handling */
314
315LRESULT CALLBACK wxSocket_Internal_WinProc(HWND hWnd,
316 UINT uMsg,
317 WPARAM wParam,
318 LPARAM lParam)
319{
320 if ( uMsg < WM_USER || uMsg > (WM_USER + MAXSOCKETS - 1))
321 return DefWindowProc(hWnd, uMsg, wParam, lParam);
322
323 wxSocketImplMSW *socket;
324 wxSocketNotify event = (wxSocketNotify)-1;
325 {
326 wxCRIT_SECT_LOCKER(lock, gs_critical);
327
328 socket = socketList[(uMsg - WM_USER)];
329 if ( !socket )
330 return 0;
331
332 // the socket may be already closed but we could still receive
333 // notifications for it sent (asynchronously) before it got closed
334 if ( socket->m_fd == INVALID_SOCKET )
335 return 0;
336
337 wxASSERT_MSG( socket->m_fd == (SOCKET)wParam,
338 "mismatch between message and socket?" );
339
340 switch ( WSAGETSELECTEVENT(lParam) )
341 {
342 case FD_READ:
343 // We may get a FD_READ notification even when there is no data
344 // to read on the socket, in particular this happens on socket
345 // creation when we seem to always get FD_CONNECT, FD_WRITE and
346 // FD_READ notifications all at once (but it doesn't happen
347 // only then). Ignore such dummy notifications.
348 {
349 fd_set fds;
350 timeval tv = { 0, 0 };
351
352 wxFD_ZERO(&fds);
353 wxFD_SET(socket->m_fd, &fds);
354
355 if ( select(socket->m_fd + 1, &fds, NULL, NULL, &tv) != 1 )
356 return 0;
357 }
358
359 event = wxSOCKET_INPUT;
360 break;
361
362 case FD_WRITE:
363 event = wxSOCKET_OUTPUT;
364 break;
365
366 case FD_ACCEPT:
367 event = wxSOCKET_CONNECTION;
368 break;
369
370 case FD_CONNECT:
371 event = WSAGETSELECTERROR(lParam) ? wxSOCKET_LOST
372 : wxSOCKET_CONNECTION;
373 break;
374
375 case FD_CLOSE:
376 event = wxSOCKET_LOST;
377 break;
378
379 default:
380 wxFAIL_MSG( "unexpected socket notification" );
381 return 0;
382 }
383 } // unlock gs_critical
384
385 socket->NotifyOnStateChange(event);
386
387 return 0;
388}
389
390/*
391 * Enable all event notifications; we need to be notified of all
392 * events for internal processing, but we will only notify users
393 * when an appropriate callback function has been installed.
394 */
395void wxSocketMSWManager::Install_Callback(wxSocketImpl *socket_,
396 wxSocketNotify WXUNUSED(event))
397{
398 wxSocketImplMSW * const socket = static_cast<wxSocketImplMSW *>(socket_);
399
400 if (socket->m_fd != INVALID_SOCKET)
401 {
402 /* We could probably just subscribe to all events regardless
403 * of the socket type, but MS recommends to do it this way.
404 */
405 long lEvent = socket->m_server?
406 FD_ACCEPT : (FD_READ | FD_WRITE | FD_CONNECT | FD_CLOSE);
407#ifndef __WXWINCE__
408 gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, lEvent);
409#else
410/*
411* WinCE creates a thread for socket event handling.
412* All needed parameters get passed through the thread_data structure.
413*/
414
415 thread_data* d = new thread_data;
416 d->lEvent = lEvent;
417 d->hEvtWin = hWin;
418 d->msgnumber = socket->m_msgnumber;
419 d->fd = socket->m_fd;
420 socketHash[socket->m_fd] = true;
421 hThread[currSocket++] = CreateThread(NULL, 0, &SocketThread,(LPVOID)d, 0, NULL);
422#endif
423 }
424}
425
426/*
427 * Disable event notifications (used when shutting down the socket)
428 */
429void wxSocketMSWManager::Uninstall_Callback(wxSocketImpl *socket_,
430 wxSocketNotify WXUNUSED(event))
431{
432 wxSocketImplMSW * const socket = static_cast<wxSocketImplMSW *>(socket_);
433
434 if (socket->m_fd != INVALID_SOCKET)
435 {
436#ifndef __WXWINCE__
437 gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
438#else
439 //Destroy the thread
440 socketHash[socket->m_fd] = false;
441#endif
442 }
443}
444
445// set the wxBase variable to point to our wxSocketManager implementation
446//
447// see comments in wx/apptrait.h for the explanation of why do we do it
448// like this
449static struct ManagerSetter
450{
451 ManagerSetter()
452 {
453 static wxSocketMSWManager s_manager;
454 wxAppTraits::SetDefaultSocketManager(&s_manager);
455 }
456} gs_managerSetter;
457
458// see the relative linker macro in socket.cpp
459wxFORCE_LINK_THIS_MODULE( mswsocket );
460
461// ============================================================================
462// wxSocketImpl implementation
463// ============================================================================
464
465void wxSocketImplMSW::DoClose()
466{
467 wxSocketManager::Get()->Uninstall_Callback(this);
468
469 closesocket(m_fd);
470}
471
472wxSocketError wxSocketImplMSW::GetLastError() const
473{
474 switch ( WSAGetLastError() )
475 {
476 case 0:
477 return wxSOCKET_NOERROR;
478
479 case WSAENOTSOCK:
480 return wxSOCKET_INVSOCK;
481
482 case WSAEWOULDBLOCK:
483 return wxSOCKET_WOULDBLOCK;
484
485 default:
486 return wxSOCKET_IOERR;
487 }
488}
489
490#endif // wxUSE_SOCKETS