1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Socket handling classes
4 // Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
8 // Copyright: (c) Guilhem Lavaux
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_NETWORK_SOCKET_H
13 #define _WX_NETWORK_SOCKET_H
16 #pragma interface "socket.h"
23 // ---------------------------------------------------------------------------
25 // ---------------------------------------------------------------------------
28 # include "wx/wxprec.h"
30 # include "wx/event.h"
31 # include "wx/string.h"
34 #include "wx/sckaddr.h"
35 #include "wx/gsocket.h"
37 // ------------------------------------------------------------------------
38 // Types and constants
39 // ------------------------------------------------------------------------
43 wxSOCKET_INPUT
= GSOCK_INPUT
,
44 wxSOCKET_OUTPUT
= GSOCK_OUTPUT
,
45 wxSOCKET_CONNECTION
= GSOCK_CONNECTION
,
46 wxSOCKET_LOST
= GSOCK_LOST
51 wxSOCKET_INPUT_FLAG
= GSOCK_INPUT_FLAG
,
52 wxSOCKET_OUTPUT_FLAG
= GSOCK_OUTPUT_FLAG
,
53 wxSOCKET_CONNECTION_FLAG
= GSOCK_CONNECTION_FLAG
,
54 wxSOCKET_LOST_FLAG
= GSOCK_LOST_FLAG
57 typedef GSocketEventFlags wxSocketEventFlags
;
61 wxSOCKET_NOERROR
= GSOCK_NOERROR
,
62 wxSOCKET_INPOP
= GSOCK_INVOP
,
63 wxSOCKET_IOERR
= GSOCK_IOERR
,
64 wxSOCKET_INVADDR
= GSOCK_INVADDR
,
65 wxSOCKET_INVSOCK
= GSOCK_INVSOCK
,
66 wxSOCKET_NOHOST
= GSOCK_NOHOST
,
67 wxSOCKET_INVPORT
= GSOCK_INVPORT
,
68 wxSOCKET_WOULDBLOCK
= GSOCK_WOULDBLOCK
,
69 wxSOCKET_TIMEDOUT
= GSOCK_TIMEDOUT
,
70 wxSOCKET_MEMERR
= GSOCK_MEMERR
91 typedef int wxSocketFlags
;
96 #if WXWIN_COMPATIBILITY
98 typedef wxSocketType wxSockType
;
99 typedef wxSocketFlags wxSockFlags
;
101 #endif // WXWIN_COMPATIBILITY
103 // --------------------------------------------------------------------------
105 // --------------------------------------------------------------------------
107 class WXDLLEXPORT wxSocketBase
: public wxObject
109 DECLARE_CLASS(wxSocketBase
)
113 #if WXWIN_COMPATIBILITY
116 NONE
= wxSOCKET_NONE
,
117 NOWAIT
= wxSOCKET_NOWAIT
,
118 WAITALL
= wxSOCKET_WAITALL
,
119 SPEED
= wxSOCKET_BLOCK
124 SOCK_UNINIT
= wxSOCKET_UNINIT
,
125 SOCK_CLIENT
= wxSOCKET_CLIENT
,
126 SOCK_SERVER
= wxSOCKET_SERVER
,
127 SOCK_INTERNAL
= wxSOCKET_BASE
,
128 SOCK_DATAGRAM
= wxSOCKET_DATAGRAM
130 #endif // WXWIN_COMPATIBILITY
132 typedef void (*wxSockCbk
)(wxSocketBase
& sock
, wxSocketNotify evt
, char *cdata
);
141 wxSocketBase(wxSocketFlags flags
, wxSocketType type
);
142 virtual ~wxSocketBase();
147 inline bool Ok() const { return (m_socket
!= NULL
); };
148 inline bool Error() const { return m_error
; };
149 inline bool IsConnected() const { return m_connected
; };
150 inline bool IsData() { return WaitForRead(0, 0); };
151 inline bool IsDisconnected() const { return !IsConnected(); };
152 inline wxUint32
LastCount() const { return m_lcount
; }
153 inline wxSocketError
LastError() const { return (wxSocketError
)GSocket_GetError(m_socket
); }
158 virtual bool GetLocal(wxSockAddress
& addr_man
) const;
159 virtual bool GetPeer(wxSockAddress
& addr_man
) const;
162 virtual bool Close();
163 wxSocketBase
& Discard();
164 wxSocketBase
& Peek(char* buffer
, wxUint32 nbytes
);
165 wxSocketBase
& Read(char* buffer
, wxUint32 nbytes
);
166 wxSocketBase
& ReadMsg(char *buffer
, wxUint32 nbytes
);
167 wxSocketBase
& Unread(const char *buffer
, wxUint32 nbytes
);
168 wxSocketBase
& Write(const char *buffer
, wxUint32 nbytes
);
169 wxSocketBase
& WriteMsg(const char *buffer
, wxUint32 nbytes
);
171 void InterruptAllWaits() { m_interrupt
= TRUE
; };
172 bool Wait(long seconds
= -1, long milliseconds
= 0);
173 bool WaitForRead(long seconds
= -1, long milliseconds
= 0);
174 bool WaitForWrite(long seconds
= -1, long milliseconds
= 0);
175 bool WaitForLost(long seconds
= -1, long milliseconds
= 0);
177 inline wxSocketFlags
GetFlags() const { return m_flags
; };
178 void SetFlags(wxSocketFlags flags
);
179 void SetTimeout(long seconds
);
182 void SetEventHandler(wxEvtHandler
& handler
, int id
= -1);
183 void SetNotify(wxSocketEventFlags flags
);
184 void Notify(bool notify
);
186 // callbacks - deprecated, avoid if possible
187 wxSockCbk
Callback(wxSockCbk cbk_
);
188 char *CallbackData(char *data
);
191 // Implementation from now on
192 // --------------------------
194 // do not use, this should be private
195 void OnRequest(wxSocketNotify req_evt
);
197 // do not use, not documented nor supported
198 inline bool IsNoWait() const { return ((m_flags
& wxSOCKET_NOWAIT
) != 0); };
199 inline wxSocketType
GetType() const { return m_type
; }
204 wxUint32
_Read(char* buffer
, wxUint32 nbytes
);
205 wxUint32
_Write(const char *buffer
, wxUint32 nbytes
);
206 bool _Wait(long seconds
, long milliseconds
, wxSocketEventFlags flags
);
209 void Pushback(const char *buffer
, wxUint32 size
);
210 wxUint32
GetPushback(char *buffer
, wxUint32 size
, bool peek
);
214 GSocket
*m_socket
; // GSocket
215 wxSocketType m_type
; // wxSocket type
218 wxSocketFlags m_flags
; // wxSocket flags
219 bool m_connected
; // connected?
220 bool m_establishing
; // establishing connection?
221 bool m_reading
; // busy reading?
222 bool m_writing
; // busy writing?
223 bool m_error
; // did last IO call fail?
224 wxUint32 m_lcount
; // last IO transaction size
225 unsigned long m_timeout
; // IO timeout value
226 wxList m_states
; // stack of states
227 bool m_interrupt
; // interrupt ongoing wait operations?
228 bool m_beingDeleted
; // marked for delayed deletion?
231 char *m_unread
; // pushback buffer
232 wxUint32 m_unrd_size
; // pushback buffer size
233 wxUint32 m_unrd_cur
; // pushback pointer (index into buffer)
236 wxEvtHandler
*m_handler
; // event handler
237 int m_id
; // socket id
238 bool m_notify_state
; // notify events to users?
240 m_neededreq
; // event mask
241 wxSockCbk m_cbk
; // callback
242 char *m_cdata
; // callback data
246 // --------------------------------------------------------------------------
248 // --------------------------------------------------------------------------
250 class WXDLLEXPORT wxSocketServer
: public wxSocketBase
252 DECLARE_CLASS(wxSocketServer
)
255 wxSocketServer(wxSockAddress
& addr
, wxSocketFlags flags
= wxSOCKET_NONE
);
257 wxSocketBase
* Accept(bool wait
= TRUE
);
258 bool AcceptWith(wxSocketBase
& socket
, bool wait
= TRUE
);
260 bool WaitForAccept(long seconds
= -1, long milliseconds
= 0);
264 // --------------------------------------------------------------------------
266 // --------------------------------------------------------------------------
268 class WXDLLEXPORT wxSocketClient
: public wxSocketBase
270 DECLARE_CLASS(wxSocketClient
)
273 wxSocketClient(wxSocketFlags flags
= wxSOCKET_NONE
);
274 virtual ~wxSocketClient();
276 virtual bool Connect(wxSockAddress
& addr
, bool wait
= TRUE
);
278 bool WaitOnConnect(long seconds
= -1, long milliseconds
= 0);
282 // --------------------------------------------------------------------------
284 // --------------------------------------------------------------------------
286 // WARNING: still in alpha stage
288 class wxDatagramSocket
: public wxSocketBase
290 DECLARE_CLASS(wxDatagramSocket
)
293 wxDatagramSocket(wxSockAddress
& addr
, wxSocketFlags flags
= wxSOCKET_NONE
);
295 wxDatagramSocket
& RecvFrom( wxSockAddress
& addr
,
298 wxDatagramSocket
& SendTo( wxSockAddress
& addr
,
304 // --------------------------------------------------------------------------
306 // --------------------------------------------------------------------------
308 class WXDLLEXPORT wxSocketEvent
: public wxEvent
310 DECLARE_DYNAMIC_CLASS(wxSocketEvent
)
313 wxSocketEvent(int id
= 0);
315 wxSocketNotify
SocketEvent() const { return m_event
; }
316 wxSocketBase
*Socket() const { return m_socket
; }
318 void CopyObject(wxObject
& object_dest
) const;
321 wxSocketNotify m_event
;
322 wxSocketBase
*m_socket
;
326 typedef void (wxEvtHandler
::*wxSocketEventFunction
)(wxSocketEvent
&);
328 #define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \
329 (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
337 // _WX_NETWORK_SOCKET_H