/////////////////////////////////////////////////////////////////////////////
// Name: socket.h
// Purpose: Socket handling classes
-// Author: Guilhem Lavaux
+// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Modified by:
// Created: April 1997
// RCS-ID: $Id$
#ifndef _WX_NETWORK_SOCKET_H
#define _WX_NETWORK_SOCKET_H
-#ifdef __GNUG__
-#pragma interface "socket.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+ #pragma interface "socket.h"
#endif
+#include "wx/defs.h"
+
+#if wxUSE_SOCKETS
+
// ---------------------------------------------------------------------------
-// Windows(tm) specific
+// wxSocket headers
// ---------------------------------------------------------------------------
-#if defined(__WINDOWS__) && defined(WXSOCK_INTERNAL)
-#include <winsock.h>
-#include <wx/msw/private.h>
-struct wxSockInternal {
- UINT my_msg;
-};
+#include "wx/event.h"
+#include "wx/sckaddr.h"
+#include "wx/gsocket.h"
+#include "wx/list.h"
-struct wxSockHandlerInternal {
- HWND sockWin;
- UINT firstAvailableMsg;
+// ------------------------------------------------------------------------
+// Types and constants
+// ------------------------------------------------------------------------
+
+enum wxSocketNotify
+{
+ wxSOCKET_INPUT = GSOCK_INPUT,
+ wxSOCKET_OUTPUT = GSOCK_OUTPUT,
+ wxSOCKET_CONNECTION = GSOCK_CONNECTION,
+ wxSOCKET_LOST = GSOCK_LOST
};
-#endif // defined(__WINDOWS__) && defined(WXSOCK_INTERNAL)
-// ---------------------------------------------------------------------------
-// Unix specific
-// ---------------------------------------------------------------------------
-#if defined(__UNIX__) && defined(WXSOCK_INTERNAL)
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
+enum
+{
+ wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
+ wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
+ wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
+ wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG
+};
-// ---------------------------------------------------------------------------
-// Athena specific
-// ---------------------------------------------------------------------------
-#if defined(__WXXT__) || defined(__WXMOTIF__)
-#include <X11/Intrinsic.h>
+typedef GSocketEventFlags wxSocketEventFlags;
-struct wxSockInternal {
- XtInputId sock_inputid, sock_outputid, sock_exceptid;
+enum wxSocketError
+{
+ // from GSocket
+ wxSOCKET_NOERROR = GSOCK_NOERROR,
+ wxSOCKET_INVOP = GSOCK_INVOP,
+ wxSOCKET_IOERR = GSOCK_IOERR,
+ wxSOCKET_INVADDR = GSOCK_INVADDR,
+ wxSOCKET_INVSOCK = GSOCK_INVSOCK,
+ wxSOCKET_NOHOST = GSOCK_NOHOST,
+ wxSOCKET_INVPORT = GSOCK_INVPORT,
+ wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK,
+ wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
+ wxSOCKET_MEMERR = GSOCK_MEMERR,
+
+ // wxSocket-specific (not yet implemented)
+ wxSOCKET_DUMMY
};
-#endif
-// ---------------------------------------------------------------------------
-// GTK specific
-// ---------------------------------------------------------------------------
-#if defined(__WXGTK__)
-#include <gdk/gdk.h>
+enum
+{
+ wxSOCKET_NONE = 0,
+ wxSOCKET_NOWAIT = 1,
+ wxSOCKET_WAITALL = 2,
+ wxSOCKET_BLOCK = 4,
+ wxSOCKET_REUSEADDR = 8
+};
-struct wxSockInternal {
- gint sock_inputid, sock_outputid, sock_exceptid;
+enum wxSocketType
+{
+ wxSOCKET_UNINIT,
+ wxSOCKET_CLIENT,
+ wxSOCKET_SERVER,
+ wxSOCKET_BASE,
+ wxSOCKET_DATAGRAM
};
-#endif
-#endif // defined(__UNIX__) && defined(WXSOCK_INTERNAL)
+typedef int wxSocketFlags;
-// ---------------------------------------------------------------------------
-// wxSocket headers (generic)
-// ---------------------------------------------------------------------------
-#ifdef WXPREC
-#include <wx/wxprec.h>
-#else
-#include <wx/wx.h>
-#endif
-#include "wx/sckaddr.h"
-class WXDLLEXPORT wxSocketEvent;
-class WXDLLEXPORT wxSocketHandler;
-class WXDLLEXPORT wxSocketBase : public wxEvtHandler
+
+// --------------------------------------------------------------------------
+// wxSocketBase
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketBase : public wxObject
{
DECLARE_CLASS(wxSocketBase)
+
public:
- enum wxSockFlags { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
- // Type of request
- enum { REQ_READ=0x1, REQ_PEEK=0x2, REQ_WRITE=0x4, REQ_LOST=0x8,
- REQ_ACCEPT=0x10, REQ_CONNECT=0x20};
- enum { EVT_READ=0, EVT_PEEK=1, EVT_WRITE=2, EVT_LOST=3, EVT_ACCEPT=4,
- EVT_CONNECT=5 };
-
- typedef int wxRequestNotify;
- typedef int wxRequestEvent;
- typedef void (*wxSockCbk)(wxSocketBase& sock,wxRequestEvent evt,char *cdata);
-
-protected:
- wxList req_list[EVT_WRITE+1];
-
- // Internal use for SaveState() and RestoreState()
- class wxSockState : public wxObject {
- public:
- bool cbk_on;
- wxSockCbk cbk;
- char *cdata;
- bool notif;
- wxRequestNotify cbk_set;
- wxSockFlags flags;
- };
- typedef struct {
- char sig[4];
- char len[4];
- } SockMsg;
- enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
-
- wxSockFlags m_flags;
- wxSockType m_type; // wxSocket type
- bool m_connected, m_connecting; // State of the socket
- int m_fd; // Socket file descriptors
- int m_waitflags; // Wait flags
- wxList m_states; // States list
- wxSockCbk m_cbk; // C callback
- char *m_cdata; // C callback data
- int m_id; // Socket id (for event handler)
- wxSocketHandler *m_handler; // the current socket handler
- wxRequestNotify m_neededreq; // Specify which requet signals we need
- bool m_cbkon;
- char *m_unread; // The unread buf
- size_t m_unrd_size; // The size of the unread buf
- bool m_processing; // To prevent some endless loop
- unsigned long m_timeout;
- int m_wantbuf;
- size_t m_lcount; // Last IO request size
- int m_error; // Last IO error
- bool m_notifyme;
-
- struct wxSockInternal *m_internal; // System specific variables
+ // Public interface
+ // ----------------
-public:
+ // ctors and dtors
wxSocketBase();
+ wxSocketBase(wxSocketFlags flags, wxSocketType type);
virtual ~wxSocketBase();
- virtual bool Close();
-
- // Base IO
- wxSocketBase& Peek(char* buffer, size_t nbytes);
- wxSocketBase& Read(char* buffer, size_t nbytes);
- wxSocketBase& Write(const char *buffer, size_t nbytes);
- wxSocketBase& WriteMsg(const char *buffer, size_t nbytes);
- wxSocketBase& ReadMsg(char* buffer, size_t nbytes);
- wxSocketBase& Unread(const char *buffer, size_t nbytes);
- void Discard();
-
- // Try not to use this two methods (they sould be protected)
- void CreatePushbackAfter(const char *buffer, size_t size);
- void CreatePushbackBefore(const char *buffer, size_t size);
-
- // Status
- inline bool Ok() const { return (m_fd < 0 ? 0 : 1); };
- inline bool Error() const { return (m_error != 0); };
+ void Init();
+ bool Destroy();
+
+ // state
+ inline bool Ok() const { return (m_socket != NULL); };
+ inline bool Error() const { return m_error; };
inline bool IsConnected() const { return m_connected; };
+ inline bool IsData() { return WaitForRead(0, 0); };
inline bool IsDisconnected() const { return !IsConnected(); };
- inline bool IsNoWait() const { return m_flags & NOWAIT; };
- bool IsData() const;
- inline size_t LastCount() const { return m_lcount; }
- inline int LastError() const { return m_error; }
-
- inline void SetFlags(wxSockFlags _flags);
- inline void SetTimeout(unsigned long sec) { m_timeout = sec; }
-
- // seconds = -1 means infinite wait
- // seconds = 0 means no wait
- // seconds > 0 means specified wait
- bool Wait(long seconds = -1, long microseconds = 0);
- bool WaitForRead(long seconds = -1, long microseconds = 0);
- bool WaitForWrite(long seconds = -1, long microseconds = 0);
- bool WaitForLost(long seconds = -1, long microseconds = 0);
-
- // Save the current state of Socket
+ inline wxUint32 LastCount() const { return m_lcount; }
+ inline wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); }
void SaveState();
void RestoreState();
- // Setup external callback
- wxSockCbk Callback(wxSockCbk cbk_);
- char *CallbackData(char *data);
-
- // Setup event handler
- void SetEventHandler(wxEvtHandler& evt_hdlr, int id = -1);
-
- // Method called when it happens something on the socket
- void SetNotify(wxRequestNotify flags);
- virtual void OnRequest(wxRequestEvent req_evt);
-
- // Public internal callback
- virtual void OldOnNotify(wxRequestEvent WXUNUSED(evt));
-
- // Some info on the socket...
- virtual bool GetPeer(wxSockAddress& addr_man) const;
+ // addresses
virtual bool GetLocal(wxSockAddress& addr_man) const;
+ virtual bool GetPeer(wxSockAddress& addr_man) const;
- // Install or uninstall callbacks
+ // base IO
+ virtual bool Close();
+ wxSocketBase& Discard();
+ wxSocketBase& Peek(void* buffer, wxUint32 nbytes);
+ wxSocketBase& Read(void* buffer, wxUint32 nbytes);
+ wxSocketBase& ReadMsg(void *buffer, wxUint32 nbytes);
+ wxSocketBase& Unread(const void *buffer, wxUint32 nbytes);
+ wxSocketBase& Write(const void *buffer, wxUint32 nbytes);
+ wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes);
+
+ void InterruptWait() { m_interrupt = true; };
+ bool Wait(long seconds = -1, long milliseconds = 0);
+ bool WaitForRead(long seconds = -1, long milliseconds = 0);
+ bool WaitForWrite(long seconds = -1, long milliseconds = 0);
+ bool WaitForLost(long seconds = -1, long milliseconds = 0);
+
+ inline wxSocketFlags GetFlags() const { return m_flags; }
+ void SetFlags(wxSocketFlags flags);
+ void SetTimeout(long seconds);
+
+ bool GetOption(int level, int optname, void *optval, int *optlen);
+ bool SetOption(int level, int optname, const void *optval, int optlen);
+ inline wxUint32 GetLastIOSize() const { return m_lcount; };
+
+ // event handling
+ void *GetClientData() const { return m_clientData; }
+ void SetClientData(void *data) { m_clientData = data; }
+ void SetEventHandler(wxEvtHandler& handler, int id = wxID_ANY);
+ void SetNotify(wxSocketEventFlags flags);
void Notify(bool notify);
- // So you can know what the socket driver is looking for ...
- inline wxRequestNotify NeededReq() const { return m_neededreq; }
-
- static wxRequestNotify EventToNotify(wxRequestEvent evt);
-
-protected:
- friend class wxSocketServer;
- friend class wxSocketHandler;
+ // initialize/shutdown the sockets (usually called automatically)
+ static bool IsInitialized();
+ static bool Initialize();
+ static void Shutdown();
- wxSocketBase(wxSockFlags flags, wxSockType type);
-
- bool _Wait(long seconds, long microseconds, int type);
-
- // Set "my" handler
- inline virtual void SetHandler(wxSocketHandler *handler)
- { m_handler = handler; }
- // Activate or disactivate callback
- void SetupCallbacks();
- void DestroyCallbacks();
+ // Implementation from now on
+ // --------------------------
- // Pushback library
- size_t GetPushback(char *buffer, size_t size, bool peek);
+ // do not use, should be private (called from GSocket)
+ void OnRequest(wxSocketNotify notify);
- // To prevent many read or write on the same socket at the same time
- // ==> cause strange things :-)
- void WantSpeedBuffer(char *buffer, size_t size, wxRequestEvent req);
- void WantBuffer(char *buffer, size_t size, wxRequestEvent req);
+ // do not use, not documented nor supported
+ inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }
+ inline wxSocketType GetType() const { return m_type; }
- virtual bool DoRequests(wxRequestEvent req);
+private:
+ friend class wxSocketClient;
+ friend class wxSocketServer;
+ friend class wxDatagramSocket;
+
+ // low level IO
+ wxUint32 _Read(void* buffer, wxUint32 nbytes);
+ wxUint32 _Write(const void *buffer, wxUint32 nbytes);
+ bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags);
+
+ // pushback buffer
+ void Pushback(const void *buffer, wxUint32 size);
+ wxUint32 GetPushback(void *buffer, wxUint32 size, bool peek);
+
+private:
+ // socket
+ GSocket *m_socket; // GSocket
+ wxSocketType m_type; // wxSocket type
+
+ // state
+ wxSocketFlags m_flags; // wxSocket flags
+ bool m_connected; // connected?
+ bool m_establishing; // establishing connection?
+ bool m_reading; // busy reading?
+ bool m_writing; // busy writing?
+ bool m_error; // did last IO call fail?
+ wxSocketError m_lasterror; // last error (not cleared on success)
+ wxUint32 m_lcount; // last IO transaction size
+ unsigned long m_timeout; // IO timeout value
+ wxList m_states; // stack of states
+ bool m_interrupt; // interrupt ongoing wait operations?
+ bool m_beingDeleted; // marked for delayed deletion?
+
+ // pushback buffer
+ void *m_unread; // pushback buffer
+ wxUint32 m_unrd_size; // pushback buffer size
+ wxUint32 m_unrd_cur; // pushback pointer (index into buffer)
+
+ // events
+ int m_id; // socket id
+ wxEvtHandler *m_handler; // event handler
+ void *m_clientData; // client data for events
+ bool m_notify; // notify events to users?
+ wxSocketEventFlags m_eventmask; // which events to notify?
+
+ // the initialization count, GSocket is initialized if > 0
+ static size_t m_countInit;
+
+ DECLARE_NO_COPY_CLASS(wxSocketBase)
};
-////////////////////////////////////////////////////////////////////////
-class WXDLLEXPORT wxSocketServer : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketServer
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase
{
DECLARE_CLASS(wxSocketServer)
+
public:
+ wxSocketServer(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
- // 'service' can be a name or a port-number
+ wxSocketBase* Accept(bool wait = true);
+ bool AcceptWith(wxSocketBase& socket, bool wait = true);
- wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
+ bool WaitForAccept(long seconds = -1, long milliseconds = 0);
- wxSocketBase* Accept();
- bool AcceptWith(wxSocketBase& sock);
- virtual void OnRequest(wxRequestEvent flags);
+ DECLARE_NO_COPY_CLASS(wxSocketServer)
};
-////////////////////////////////////////////////////////////////////////
-class WXDLLEXPORT wxSocketClient : public wxSocketBase
+// --------------------------------------------------------------------------
+// wxSocketClient
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase
{
DECLARE_CLASS(wxSocketClient)
-public:
- wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
+public:
+ wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE);
virtual ~wxSocketClient();
- virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
+ virtual bool Connect(wxSockAddress& addr, bool wait = true);
- bool WaitOnConnect(long seconds = -1, long microseconds = 0);
+ bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
- virtual void OnRequest(wxRequestEvent flags);
+ DECLARE_NO_COPY_CLASS(wxSocketClient)
};
-////////////////////////////////////////////////////////////////////////
-class WXDLLEXPORT wxSocketHandler : public wxObject
+// --------------------------------------------------------------------------
+// wxDatagramSocket
+// --------------------------------------------------------------------------
+
+// WARNING: still in alpha stage
+
+class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase
{
- DECLARE_CLASS(wxSocketHandler)
-protected:
-#if defined(__WINDOWS__)
- wxList *smsg_list;
- struct wxSockHandlerInternal *internal;
-#endif
- wxList *socks;
+ DECLARE_CLASS(wxDatagramSocket)
public:
- enum SockStatus { SOCK_NONE, SOCK_DATA, SOCK_CONNECT, SOCK_DISCONNECT,
- SOCK_ERROR };
- static wxSocketHandler *master;
-
- wxSocketHandler();
- virtual ~wxSocketHandler();
-
- void Register(wxSocketBase* sock);
- void UnRegister(wxSocketBase* sock);
-
- unsigned long Count() const;
-
- // seconds = -1 means indefinite wait
- // seconds = 0 means no wait
- // seconds > 0 means specified wait
-
- int Wait(long seconds = -1, long microseconds = 0);
- void YieldSock();
-
- wxSocketServer *CreateServer
- (wxSockAddress& addr,
- wxSocketBase::wxSockFlags flags = wxSocketBase::NONE);
- wxSocketClient *CreateClient
- (wxSocketBase::wxSockFlags flags = wxSocketBase::NONE);
-
- // Create or reuse a socket handler
- static wxSocketHandler& Master() { return *master; }
-
-#if defined(WXSOCK_INTERNAL) && defined(__WINDOWS__)
-
- friend LRESULT APIENTRY _EXPORT wxSocketHandlerWndProc(HWND hWnd,
- UINT message, WPARAM wParam, LPARAM lParam);
-
- UINT NewMessage(wxSocketBase *sock);
- void DestroyMessage(UINT msg);
-
- HWND GetHWND() const;
-#endif
+ wxDatagramSocket(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE);
+
+ wxDatagramSocket& RecvFrom( wxSockAddress& addr,
+ void* buf,
+ wxUint32 nBytes );
+ wxDatagramSocket& SendTo( wxSockAddress& addr,
+ const void* buf,
+ wxUint32 nBytes );
+
+/* TODO:
+ bool Connect(wxSockAddress& addr);
+*/
+ DECLARE_NO_COPY_CLASS(wxDatagramSocket)
};
-class WXDLLEXPORT wxSocketEvent : public wxEvent {
- DECLARE_DYNAMIC_CLASS(wxSocketEvent)
+
+// --------------------------------------------------------------------------
+// wxSocketEvent
+// --------------------------------------------------------------------------
+
+class WXDLLIMPEXP_NET wxSocketEvent : public wxEvent
+{
public:
- wxSocketEvent(int id = 0);
+ wxSocketEvent(int id = 0)
+ : wxEvent(id, wxEVT_SOCKET)
+ {
+ }
+
+ wxSocketNotify GetSocketEvent() const { return m_event; }
+ wxSocketBase *GetSocket() const { return (wxSocketBase *) GetEventObject(); }
+ void *GetClientData() const { return m_clientData; }
+
+ virtual wxEvent *Clone() const { return new wxSocketEvent(*this); }
- wxSocketBase::wxRequestEvent SocketEvent() const { return m_skevt; }
public:
- wxSocketBase::wxRequestEvent m_skevt;
+ wxSocketNotify m_event;
+ void *m_clientData;
+
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSocketEvent)
};
+
typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
-#define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, 0, \
- (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
- (wxObject *) NULL },
+#define EVT_SOCKET(id, func) \
+ DECLARE_EVENT_TABLE_ENTRY( wxEVT_SOCKET, id, wxID_ANY, \
+ (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxSocketEventFunction, & func ), \
+ (wxObject *) NULL ),
+
+
+#endif
+ // wxUSE_SOCKETS
#endif
+ // _WX_NETWORK_SOCKET_H
projects / wxWidgets.git / blobdiff