]>
Commit | Line | Data |
---|---|---|
f4ada568 GL |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: socket.h | |
3 | // Purpose: Socket handling classes | |
fade627a | 4 | // Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia |
f4ada568 GL |
5 | // Modified by: |
6 | // Created: April 1997 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Guilhem Lavaux | |
65571936 | 9 | // Licence: wxWindows licence |
f4ada568 | 10 | ///////////////////////////////////////////////////////////////////////////// |
0c32066b | 11 | |
7fa03f04 VZ |
12 | #ifndef _WX_SOCKET_H_ |
13 | #define _WX_SOCKET_H_ | |
f4ada568 | 14 | |
ce4169a4 RR |
15 | #include "wx/defs.h" |
16 | ||
17 | #if wxUSE_SOCKETS | |
18 | ||
f4ada568 | 19 | // --------------------------------------------------------------------------- |
71622a7a | 20 | // wxSocket headers |
f4ada568 | 21 | // --------------------------------------------------------------------------- |
483249fc | 22 | |
372c511b | 23 | #include "wx/event.h" |
ed58dbea | 24 | #include "wx/sckaddr.h" |
65ccd2b8 | 25 | #include "wx/gsocket.h" |
b8ddac49 | 26 | #include "wx/list.h" |
f4ada568 | 27 | |
aa8fb7a0 | 28 | // ------------------------------------------------------------------------ |
71622a7a | 29 | // Types and constants |
aa8fb7a0 GL |
30 | // ------------------------------------------------------------------------ |
31 | ||
a64a02ef VZ |
32 | enum wxSocketNotify |
33 | { | |
aa8fb7a0 GL |
34 | wxSOCKET_INPUT = GSOCK_INPUT, |
35 | wxSOCKET_OUTPUT = GSOCK_OUTPUT, | |
36 | wxSOCKET_CONNECTION = GSOCK_CONNECTION, | |
37 | wxSOCKET_LOST = GSOCK_LOST | |
a64a02ef | 38 | }; |
aa8fb7a0 | 39 | |
a64a02ef VZ |
40 | enum |
41 | { | |
aa8fb7a0 GL |
42 | wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG, |
43 | wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG, | |
44 | wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG, | |
feeb8165 | 45 | wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG |
aa8fb7a0 GL |
46 | }; |
47 | ||
48 | typedef GSocketEventFlags wxSocketEventFlags; | |
49 | ||
a64a02ef VZ |
50 | enum wxSocketError |
51 | { | |
5c9eff30 | 52 | // from GSocket |
aa8fb7a0 | 53 | wxSOCKET_NOERROR = GSOCK_NOERROR, |
5c9eff30 | 54 | wxSOCKET_INVOP = GSOCK_INVOP, |
aa8fb7a0 GL |
55 | wxSOCKET_IOERR = GSOCK_IOERR, |
56 | wxSOCKET_INVADDR = GSOCK_INVADDR, | |
57 | wxSOCKET_INVSOCK = GSOCK_INVSOCK, | |
58 | wxSOCKET_NOHOST = GSOCK_NOHOST, | |
59 | wxSOCKET_INVPORT = GSOCK_INVPORT, | |
60 | wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK, | |
aa6d9706 | 61 | wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT, |
5c9eff30 GRG |
62 | wxSOCKET_MEMERR = GSOCK_MEMERR, |
63 | ||
64 | // wxSocket-specific (not yet implemented) | |
65 | wxSOCKET_DUMMY | |
a64a02ef | 66 | }; |
aa8fb7a0 | 67 | |
a64a02ef VZ |
68 | enum |
69 | { | |
483249fc GRG |
70 | wxSOCKET_NONE = 0, |
71 | wxSOCKET_NOWAIT = 1, | |
72 | wxSOCKET_WAITALL = 2, | |
74c481d1 VZ |
73 | wxSOCKET_BLOCK = 4, |
74 | wxSOCKET_REUSEADDR = 8 | |
483249fc GRG |
75 | }; |
76 | ||
71622a7a | 77 | enum wxSocketType |
a64a02ef | 78 | { |
71622a7a GRG |
79 | wxSOCKET_UNINIT, |
80 | wxSOCKET_CLIENT, | |
81 | wxSOCKET_SERVER, | |
82 | wxSOCKET_BASE, | |
83 | wxSOCKET_DATAGRAM | |
a64a02ef VZ |
84 | }; |
85 | ||
71622a7a | 86 | typedef int wxSocketFlags; |
483249fc | 87 | |
aa8fb7a0 | 88 | |
bffc1eaa | 89 | |
71622a7a GRG |
90 | // -------------------------------------------------------------------------- |
91 | // wxSocketBase | |
92 | // -------------------------------------------------------------------------- | |
93 | ||
7c4728f6 | 94 | class WXDLLIMPEXP_NET wxSocketBase : public wxObject |
f4ada568 GL |
95 | { |
96 | DECLARE_CLASS(wxSocketBase) | |
71622a7a | 97 | |
71622a7a | 98 | public: |
81b92e17 | 99 | |
71622a7a GRG |
100 | // Public interface |
101 | // ---------------- | |
65ccd2b8 | 102 | |
71622a7a | 103 | // ctors and dtors |
f4ada568 | 104 | wxSocketBase(); |
71622a7a | 105 | wxSocketBase(wxSocketFlags flags, wxSocketType type); |
f4ada568 | 106 | virtual ~wxSocketBase(); |
71622a7a GRG |
107 | void Init(); |
108 | bool Destroy(); | |
f4ada568 | 109 | |
71622a7a | 110 | // state |
a324a7bc | 111 | inline bool Ok() const { return (m_socket != NULL); }; |
7c395bf3 | 112 | inline bool Error() const { return m_error; }; |
f4ada568 | 113 | inline bool IsConnected() const { return m_connected; }; |
483249fc | 114 | inline bool IsData() { return WaitForRead(0, 0); }; |
71622a7a | 115 | inline bool IsDisconnected() const { return !IsConnected(); }; |
aa6d9706 | 116 | inline wxUint32 LastCount() const { return m_lcount; } |
57b1deb3 | 117 | inline wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); } |
71622a7a GRG |
118 | void SaveState(); |
119 | void RestoreState(); | |
65ccd2b8 | 120 | |
71622a7a | 121 | // addresses |
7c395bf3 | 122 | virtual bool GetLocal(wxSockAddress& addr_man) const; |
71622a7a | 123 | virtual bool GetPeer(wxSockAddress& addr_man) const; |
33d925b0 | 124 | virtual bool SetLocal(wxSockAddress& local); |
7c395bf3 | 125 | |
71622a7a GRG |
126 | // base IO |
127 | virtual bool Close(); | |
128 | wxSocketBase& Discard(); | |
f187448d GRG |
129 | wxSocketBase& Peek(void* buffer, wxUint32 nbytes); |
130 | wxSocketBase& Read(void* buffer, wxUint32 nbytes); | |
131 | wxSocketBase& ReadMsg(void *buffer, wxUint32 nbytes); | |
132 | wxSocketBase& Unread(const void *buffer, wxUint32 nbytes); | |
133 | wxSocketBase& Write(const void *buffer, wxUint32 nbytes); | |
134 | wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes); | |
71622a7a | 135 | |
d775fa82 | 136 | void InterruptWait() { m_interrupt = true; }; |
aa6d9706 GL |
137 | bool Wait(long seconds = -1, long milliseconds = 0); |
138 | bool WaitForRead(long seconds = -1, long milliseconds = 0); | |
139 | bool WaitForWrite(long seconds = -1, long milliseconds = 0); | |
140 | bool WaitForLost(long seconds = -1, long milliseconds = 0); | |
65ccd2b8 | 141 | |
f187448d | 142 | inline wxSocketFlags GetFlags() const { return m_flags; } |
71622a7a GRG |
143 | void SetFlags(wxSocketFlags flags); |
144 | void SetTimeout(long seconds); | |
65ccd2b8 | 145 | |
bfa7bf7d VZ |
146 | bool GetOption(int level, int optname, void *optval, int *optlen); |
147 | bool SetOption(int level, int optname, const void *optval, int optlen); | |
148 | inline wxUint32 GetLastIOSize() const { return m_lcount; }; | |
149 | ||
71622a7a | 150 | // event handling |
f187448d GRG |
151 | void *GetClientData() const { return m_clientData; } |
152 | void SetClientData(void *data) { m_clientData = data; } | |
d775fa82 | 153 | void SetEventHandler(wxEvtHandler& handler, int id = wxID_ANY); |
aa8fb7a0 | 154 | void SetNotify(wxSocketEventFlags flags); |
7c395bf3 | 155 | void Notify(bool notify); |
7c395bf3 | 156 | |
6c0d0845 VZ |
157 | // initialize/shutdown the sockets (usually called automatically) |
158 | static bool IsInitialized(); | |
159 | static bool Initialize(); | |
160 | static void Shutdown(); | |
161 | ||
f4ada568 | 162 | |
71622a7a GRG |
163 | // Implementation from now on |
164 | // -------------------------- | |
f4ada568 | 165 | |
5c9eff30 | 166 | // do not use, should be private (called from GSocket) |
bffc1eaa | 167 | void OnRequest(wxSocketNotify notify); |
ce3ed50d | 168 | |
71622a7a | 169 | // do not use, not documented nor supported |
bffc1eaa | 170 | inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); } |
71622a7a | 171 | inline wxSocketType GetType() const { return m_type; } |
ce3ed50d | 172 | |
fbf5995c GRG |
173 | private: |
174 | friend class wxSocketClient; | |
175 | friend class wxSocketServer; | |
176 | friend class wxDatagramSocket; | |
65ccd2b8 | 177 | |
71622a7a | 178 | // low level IO |
f187448d GRG |
179 | wxUint32 _Read(void* buffer, wxUint32 nbytes); |
180 | wxUint32 _Write(const void *buffer, wxUint32 nbytes); | |
5c9eff30 | 181 | bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags); |
f4ada568 | 182 | |
71622a7a | 183 | // pushback buffer |
5c9eff30 | 184 | void Pushback(const void *buffer, wxUint32 size); |
f187448d | 185 | wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek); |
71622a7a | 186 | |
fbf5995c | 187 | private: |
5c9eff30 | 188 | // socket |
71622a7a GRG |
189 | GSocket *m_socket; // GSocket |
190 | wxSocketType m_type; // wxSocket type | |
191 | ||
192 | // state | |
193 | wxSocketFlags m_flags; // wxSocket flags | |
194 | bool m_connected; // connected? | |
195 | bool m_establishing; // establishing connection? | |
196 | bool m_reading; // busy reading? | |
197 | bool m_writing; // busy writing? | |
198 | bool m_error; // did last IO call fail? | |
5c9eff30 | 199 | wxSocketError m_lasterror; // last error (not cleared on success) |
71622a7a GRG |
200 | wxUint32 m_lcount; // last IO transaction size |
201 | unsigned long m_timeout; // IO timeout value | |
202 | wxList m_states; // stack of states | |
203 | bool m_interrupt; // interrupt ongoing wait operations? | |
204 | bool m_beingDeleted; // marked for delayed deletion? | |
205 | ||
206 | // pushback buffer | |
f187448d | 207 | void *m_unread; // pushback buffer |
71622a7a GRG |
208 | wxUint32 m_unrd_size; // pushback buffer size |
209 | wxUint32 m_unrd_cur; // pushback pointer (index into buffer) | |
210 | ||
211 | // events | |
71622a7a | 212 | int m_id; // socket id |
f187448d GRG |
213 | wxEvtHandler *m_handler; // event handler |
214 | void *m_clientData; // client data for events | |
bffc1eaa GRG |
215 | bool m_notify; // notify events to users? |
216 | wxSocketEventFlags m_eventmask; // which events to notify? | |
f187448d | 217 | |
6c0d0845 VZ |
218 | // the initialization count, GSocket is initialized if > 0 |
219 | static size_t m_countInit; | |
220 | ||
33d925b0 | 221 | DECLARE_NO_COPY_CLASS(wxSocketBase) |
f4ada568 GL |
222 | }; |
223 | ||
71622a7a GRG |
224 | |
225 | // -------------------------------------------------------------------------- | |
226 | // wxSocketServer | |
227 | // -------------------------------------------------------------------------- | |
f4ada568 | 228 | |
7c4728f6 | 229 | class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase |
f4ada568 GL |
230 | { |
231 | DECLARE_CLASS(wxSocketServer) | |
f4ada568 | 232 | |
71622a7a | 233 | public: |
fbfb8bcc | 234 | wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); |
f4ada568 | 235 | |
d775fa82 WS |
236 | wxSocketBase* Accept(bool wait = true); |
237 | bool AcceptWith(wxSocketBase& socket, bool wait = true); | |
35809fe3 | 238 | |
7c395bf3 | 239 | bool WaitForAccept(long seconds = -1, long milliseconds = 0); |
0fccfc51 MB |
240 | |
241 | DECLARE_NO_COPY_CLASS(wxSocketServer) | |
f4ada568 GL |
242 | }; |
243 | ||
71622a7a GRG |
244 | |
245 | // -------------------------------------------------------------------------- | |
246 | // wxSocketClient | |
247 | // -------------------------------------------------------------------------- | |
f4ada568 | 248 | |
7c4728f6 | 249 | class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase |
f4ada568 GL |
250 | { |
251 | DECLARE_CLASS(wxSocketClient) | |
f4ada568 | 252 | |
71622a7a GRG |
253 | public: |
254 | wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE); | |
f4ada568 GL |
255 | virtual ~wxSocketClient(); |
256 | ||
d775fa82 | 257 | virtual bool Connect(wxSockAddress& addr, bool wait = true); |
33d925b0 | 258 | virtual bool Connect(wxSockAddress& addr, wxSockAddress& local, bool wait = true); |
f4ada568 | 259 | |
aa6d9706 | 260 | bool WaitOnConnect(long seconds = -1, long milliseconds = 0); |
0fccfc51 | 261 | |
33d925b0 KH |
262 | private: |
263 | virtual bool DoConnect(wxSockAddress& addr, wxSockAddress* local, bool wait = true); | |
264 | ||
0fccfc51 | 265 | DECLARE_NO_COPY_CLASS(wxSocketClient) |
f4ada568 GL |
266 | }; |
267 | ||
71622a7a GRG |
268 | |
269 | // -------------------------------------------------------------------------- | |
270 | // wxDatagramSocket | |
271 | // -------------------------------------------------------------------------- | |
272 | ||
273 | // WARNING: still in alpha stage | |
dc5c1114 | 274 | |
7c4728f6 | 275 | class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase |
dc5c1114 GRG |
276 | { |
277 | DECLARE_CLASS(wxDatagramSocket) | |
278 | ||
279 | public: | |
fbfb8bcc | 280 | wxDatagramSocket(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); |
dc5c1114 GRG |
281 | |
282 | wxDatagramSocket& RecvFrom( wxSockAddress& addr, | |
f187448d | 283 | void* buf, |
dc5c1114 | 284 | wxUint32 nBytes ); |
fbfb8bcc | 285 | wxDatagramSocket& SendTo( const wxSockAddress& addr, |
f187448d | 286 | const void* buf, |
dc5c1114 | 287 | wxUint32 nBytes ); |
5c9eff30 GRG |
288 | |
289 | /* TODO: | |
290 | bool Connect(wxSockAddress& addr); | |
291 | */ | |
0fccfc51 | 292 | DECLARE_NO_COPY_CLASS(wxDatagramSocket) |
dc5c1114 GRG |
293 | }; |
294 | ||
dc5c1114 | 295 | |
71622a7a GRG |
296 | // -------------------------------------------------------------------------- |
297 | // wxSocketEvent | |
298 | // -------------------------------------------------------------------------- | |
299 | ||
7c4728f6 | 300 | class WXDLLIMPEXP_NET wxSocketEvent : public wxEvent |
71622a7a | 301 | { |
f4ada568 | 302 | public: |
163f3154 VZ |
303 | wxSocketEvent(int id = 0) |
304 | : wxEvent(id, wxEVT_SOCKET) | |
305 | { | |
306 | } | |
f4ada568 | 307 | |
f187448d GRG |
308 | wxSocketNotify GetSocketEvent() const { return m_event; } |
309 | wxSocketBase *GetSocket() const { return (wxSocketBase *) GetEventObject(); } | |
310 | void *GetClientData() const { return m_clientData; } | |
311 | ||
163f3154 | 312 | virtual wxEvent *Clone() const { return new wxSocketEvent(*this); } |
aadbdf11 | 313 | |
f4ada568 | 314 | public: |
71622a7a | 315 | wxSocketNotify m_event; |
f187448d | 316 | void *m_clientData; |
163f3154 | 317 | |
a6cbc4db | 318 | DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSocketEvent) |
f4ada568 GL |
319 | }; |
320 | ||
71622a7a | 321 | |
f4ada568 GL |
322 | typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&); |
323 | ||
7fa03f04 | 324 | #define wxSocketEventHandler(func) \ |
8bc3ec1f | 325 | (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func) |
7fa03f04 | 326 | |
2e4df4bf | 327 | #define EVT_SOCKET(id, func) \ |
7fa03f04 | 328 | wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func)) |
f4ada568 | 329 | |
7fa03f04 | 330 | #endif // wxUSE_SOCKETS |
71622a7a | 331 | |
7fa03f04 | 332 | #endif // _WX_SOCKET_H_ |
ce4169a4 | 333 |