X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/feeb8165970889f393d4a1bf2dae2a1505fd5e4c..d1c8aaa3ee8e2051ebd20042b7e59a511c276ca2:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index 9103aeb2f2..0b955b128d 100644 --- a/include/wx/socket.h +++ b/include/wx/socket.h @@ -1,7 +1,7 @@ ///////////////////////////////////////////////////////////////////////////// // Name: socket.h // Purpose: Socket handling classes -// Author: Guilhem Lavaux +// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia // Modified by: // Created: April 1997 // RCS-ID: $Id$ @@ -13,7 +13,7 @@ #define _WX_NETWORK_SOCKET_H #ifdef __GNUG__ -#pragma interface "socket.h" + #pragma interface "socket.h" #endif #include "wx/defs.h" @@ -21,30 +21,33 @@ #if wxUSE_SOCKETS // --------------------------------------------------------------------------- -// wxSocket headers (generic) +// wxSocket headers // --------------------------------------------------------------------------- + #ifdef WXPREC -# include "wx/wxprec.h" + #include "wx/wxprec.h" #else -# include "wx/event.h" -# include "wx/string.h" + #include "wx/event.h" + #include "wx/string.h" #endif #include "wx/sckaddr.h" #include "wx/gsocket.h" // ------------------------------------------------------------------------ -// GSocket type alias +// Types and constants // ------------------------------------------------------------------------ -typedef enum { +enum wxSocketNotify +{ wxSOCKET_INPUT = GSOCK_INPUT, wxSOCKET_OUTPUT = GSOCK_OUTPUT, wxSOCKET_CONNECTION = GSOCK_CONNECTION, wxSOCKET_LOST = GSOCK_LOST -} wxSocketNotify; +}; -enum { +enum +{ wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG, wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG, wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG, @@ -53,9 +56,11 @@ enum { typedef GSocketEventFlags wxSocketEventFlags; -typedef enum { +enum wxSocketError +{ + // from GSocket wxSOCKET_NOERROR = GSOCK_NOERROR, - wxSOCKET_INPOP = GSOCK_INVOP, + wxSOCKET_INVOP = GSOCK_INVOP, wxSOCKET_IOERR = GSOCK_IOERR, wxSOCKET_INVADDR = GSOCK_INVADDR, wxSOCKET_INVSOCK = GSOCK_INVSOCK, @@ -63,205 +68,290 @@ typedef enum { wxSOCKET_INVPORT = GSOCK_INVPORT, wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK, wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT, - wxSOCKET_MEMERR = GSOCK_MEMERR -} wxSocketError; + wxSOCKET_MEMERR = GSOCK_MEMERR, -// ------------------------------------------------------------------------ -// wxSocket base -// ------------------------------------------------------------------------ + // wxSocket-specific (not yet implemented) + wxSOCKET_DUMMY +}; -class WXDLLEXPORT wxTimer; -class WXDLLEXPORT wxSocketEvent; -class WXDLLEXPORT wxSocketBase : public wxEvtHandler +enum { - DECLARE_CLASS(wxSocketBase) -public: + wxSOCKET_NONE = 0, + wxSOCKET_NOWAIT = 1, + wxSOCKET_WAITALL = 2, + wxSOCKET_BLOCK = 4 +}; + +enum wxSocketType +{ + wxSOCKET_UNINIT, + wxSOCKET_CLIENT, + wxSOCKET_SERVER, + wxSOCKET_BASE, + wxSOCKET_DATAGRAM +}; - enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 }; - typedef int wxSockFlags; - // Type of request +typedef int wxSocketFlags; - enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT }; - typedef void (*wxSockCbk)(wxSocketBase& sock,wxSocketNotify evt,char *cdata); -protected: - GSocket *m_socket; // wxSocket socket - wxSockFlags m_flags; // wxSocket flags - wxSockType m_type; // wxSocket type - wxSocketEventFlags m_neededreq; // Specify which requet signals we need - wxUint32 m_lcount; // Last IO request size - unsigned long m_timeout; // IO timeout value +#if WXWIN_COMPATIBILITY + typedef wxSocketType wxSockType; + typedef wxSocketFlags wxSockFlags; +#endif // WXWIN_COMPATIBILITY - char *m_unread; // Pushback buffer - wxUint32 m_unrd_size; // Pushback buffer size - wxUint32 m_unrd_cur; // Pushback pointer - wxSockCbk m_cbk; // C callback - char *m_cdata; // C callback data +// -------------------------------------------------------------------------- +// wxSocketBase +// -------------------------------------------------------------------------- - bool m_connected; // Connected ? - bool m_notify_state; // Notify state - int m_id; // Socket id (for event handler) +class WXDLLEXPORT wxSocketBase : public wxObject +{ + DECLARE_CLASS(wxSocketBase) - // Defering variables - enum { - DEFER_READ, DEFER_WRITE, NO_DEFER - } m_defering; // Defering state - char *m_defer_buffer; // Defering target buffer - wxUint32 m_defer_nbytes; // Defering buffer size - wxTimer *m_defer_timer; // Timer for defering mode +public: - wxList m_states; // Stack of states +#if WXWIN_COMPATIBILITY + enum + { + NONE = wxSOCKET_NONE, + NOWAIT = wxSOCKET_NOWAIT, + WAITALL = wxSOCKET_WAITALL, + SPEED = wxSOCKET_BLOCK + }; + + enum + { + SOCK_UNINIT = wxSOCKET_UNINIT, + SOCK_CLIENT = wxSOCKET_CLIENT, + SOCK_SERVER = wxSOCKET_SERVER, + SOCK_INTERNAL = wxSOCKET_BASE, + SOCK_DATAGRAM = wxSOCKET_DATAGRAM + }; + + typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata); +#endif // WXWIN_COMPATIBILITY public: + + // Public interface + // ---------------- + + // ctors and dtors wxSocketBase(); + wxSocketBase(wxSocketFlags flags, wxSocketType type); virtual ~wxSocketBase(); - virtual bool Close(); - - // Base IO - wxSocketBase& Peek(char* buffer, wxUint32 nbytes); - wxSocketBase& Read(char* buffer, wxUint32 nbytes); - wxSocketBase& Write(const char *buffer, wxUint32 nbytes); - wxSocketBase& Unread(const char *buffer, wxUint32 nbytes); - wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes); - wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes); - void Discard(); - - // Try not to use this two methods (they sould be protected) - void CreatePushbackAfter(const char *buffer, wxUint32 size); - void CreatePushbackBefore(const char *buffer, wxUint32 size); - - // Status + void Init(); + bool Destroy(); + + // state inline bool Ok() const { return (m_socket != NULL); }; - inline bool Error() const - { return (GSocket_GetError(m_socket) != GSOCK_NOERROR); }; + 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) != 0); }; - bool IsData() const; inline wxUint32 LastCount() const { return m_lcount; } inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); } - inline wxSockType GetType() const { return m_type; } + void SaveState(); + void RestoreState(); - void SetFlags(wxSockFlags _flags); - wxSockFlags GetFlags() const; - void SetTimeout(unsigned long sec); + // addresses + virtual bool GetLocal(wxSockAddress& addr_man) const; + virtual bool GetPeer(wxSockAddress& addr_man) const; - // seconds = -1 means infinite wait - // seconds = 0 means no wait - // seconds > 0 means specified wait + // 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); - // Save the current state of Socket - 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); + inline wxSocketFlags GetFlags() const { return m_flags; } + void SetFlags(wxSocketFlags flags); + void SetTimeout(long seconds); - // Method called when it happens something on the socket + // event handling + void *GetClientData() const { return m_clientData; } + void SetClientData(void *data) { m_clientData = data; } + void SetEventHandler(wxEvtHandler& handler, int id = -1); void SetNotify(wxSocketEventFlags flags); - virtual void OnRequest(wxSocketNotify req_evt); - - // Public internal callback - virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt)); - - // Some info on the socket... - virtual bool GetPeer(wxSockAddress& addr_man) const; - virtual bool GetLocal(wxSockAddress& addr_man) const; - - // Install or uninstall callbacks void Notify(bool notify); - // So you can know what the socket driver is looking for ... - inline wxSocketEventFlags NeededReq() const { return m_neededreq; } - - static wxSocketEventFlags EventToNotify(wxSocketNotify evt); - -protected: - friend class wxSocketServer; - friend class wxSocketHandler; - friend class wxSocketInternal; - -#ifdef __SALFORDC__ -public: -#endif + // callbacks are deprecated, use events instead +#if WXWIN_COMPATIBILITY + wxSockCbk Callback(wxSockCbk cbk_); + char *CallbackData(char *data); +#endif // WXWIN_COMPATIBILITY - wxSocketBase(wxSockFlags flags, wxSockType type); -#ifdef __SALFORDC__ -protected: -#endif + // Implementation from now on + // -------------------------- - bool _Wait(long seconds, long milliseconds, int type); + // do not use, should be private (called from GSocket) + void OnRequest(wxSocketNotify notify); - int DeferRead(char *buffer, wxUint32 nbytes); - int DeferWrite(const char *buffer, wxUint32 nbytes); - void DoDefer(wxSocketNotify evt); + // do not use, not documented nor supported + inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); } + inline wxSocketType GetType() const { return m_type; } - // Pushback library - wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek); +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? + + // callbacks are deprecated, use events instead +#if WXWIN_COMPATIBILITY + wxSockCbk m_cbk; // callback + char *m_cdata; // callback data +#endif // WXWIN_COMPATIBILITY }; -//////////////////////////////////////////////////////////////////////// + +// -------------------------------------------------------------------------- +// wxSocketServer +// -------------------------------------------------------------------------- class WXDLLEXPORT wxSocketServer : public wxSocketBase { DECLARE_CLASS(wxSocketServer) -public: - // 'service' can be a name or a port-number +public: + wxSocketServer(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); - wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE); + wxSocketBase* Accept(bool wait = TRUE); + bool AcceptWith(wxSocketBase& socket, bool wait = TRUE); - wxSocketBase* Accept(); - bool AcceptWith(wxSocketBase& sock); + bool WaitForAccept(long seconds = -1, long milliseconds = 0); }; -//////////////////////////////////////////////////////////////////////// + +// -------------------------------------------------------------------------- +// wxSocketClient +// -------------------------------------------------------------------------- class WXDLLEXPORT 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 milliseconds = 0); +}; + + +// -------------------------------------------------------------------------- +// wxDatagramSocket +// -------------------------------------------------------------------------- + +// WARNING: still in alpha stage + +class wxDatagramSocket : public wxSocketBase +{ + DECLARE_CLASS(wxDatagramSocket) - virtual void OnRequest(wxSocketNotify flags); +public: + 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); +*/ }; -class WXDLLEXPORT wxSocketEvent : public wxEvent { + +// -------------------------------------------------------------------------- +// wxSocketEvent +// -------------------------------------------------------------------------- + +class WXDLLEXPORT wxSocketEvent : public wxEvent +{ DECLARE_DYNAMIC_CLASS(wxSocketEvent) + public: wxSocketEvent(int id = 0); - wxSocketNotify SocketEvent() const { return m_skevt; } - wxSocketBase *Socket() const { return m_socket; } + wxSocketNotify GetSocketEvent() const { return m_event; } + wxSocketBase *GetSocket() const { return (wxSocketBase *) GetEventObject(); } + void *GetClientData() const { return m_clientData; } + + // backwards compatibility +#if WXWIN_COMPATIBILITY_2 + wxSocketNotify SocketEvent() const { return m_event; } + wxSocketBase *Socket() const { return (wxSocketBase *) GetEventObject(); } +#endif // WXWIN_COMPATIBILITY_2 - void CopyObject(wxObject& obj_d) const; + void CopyObject(wxObject& object_dest) const; public: - wxSocketNotify m_skevt; - wxSocketBase *m_socket; + wxSocketNotify m_event; + void *m_clientData; }; + typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&); #define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \ (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \ - (wxObject *) NULL }, + (wxObject *) NULL }, + #endif // wxUSE_SOCKETS