X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/39b91ecabeb35ad879412df1bcd1cec9ea97a20a..2d996ed1c44a591c610e51d58d0bf9f802fac165:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index 762e01c863..22f5d74bfd 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$ @@ -24,15 +24,52 @@ // wxSocket headers (generic) // --------------------------------------------------------------------------- #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/sckaddr.h" #include "wx/gsocket.h" +// ------------------------------------------------------------------------ +// GSocket type alias +// ------------------------------------------------------------------------ + +typedef enum { + wxSOCKET_INPUT = GSOCK_INPUT, + wxSOCKET_OUTPUT = GSOCK_OUTPUT, + wxSOCKET_CONNECTION = GSOCK_CONNECTION, + wxSOCKET_LOST = GSOCK_LOST +} wxSocketNotify; + +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 +}; + +typedef GSocketEventFlags wxSocketEventFlags; + +typedef enum { + wxSOCKET_NOERROR = GSOCK_NOERROR, + wxSOCKET_INPOP = 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 +} wxSocketError; + +// ------------------------------------------------------------------------ +// wxSocket base +// ------------------------------------------------------------------------ + class WXDLLEXPORT wxTimer; class WXDLLEXPORT wxSocketEvent; class WXDLLEXPORT wxSocketBase : public wxEvtHandler @@ -45,36 +82,37 @@ public: // Type of request enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT }; - typedef void (*wxSockCbk)(wxSocketBase& sock,GSocketEvent evt,char *cdata); + 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 - GSocketEventFlags m_neededreq; // Specify which requet signals we need - size_t m_lcount; // Last IO request size + wxSocketEventFlags m_neededreq; // Which events we are interested in + wxUint32 m_lcount; // Last IO request size unsigned long m_timeout; // IO timeout value + + char *m_unread; // Pushback buffer + wxUint32 m_unrd_size; // Pushback buffer size + wxUint32 m_unrd_cur; // Pushback pointer - char *m_unread; // Pushback buffer - size_t m_unrd_size; // Pushback buffer size - size_t m_unrd_cur; // Pushback pointer + wxSockCbk m_cbk; // C callback + char *m_cdata; // C callback data - wxSockCbk m_cbk; // C callback - char *m_cdata; // C callback data - - bool m_connected; // Connected ? + bool m_connected; // Connected ? + bool m_establishing; // Pending connections? bool m_notify_state; // Notify state - int m_id; // Socket id (for event handler) + int m_id; // Socket id (for event handler) // Defering variables enum { DEFER_READ, DEFER_WRITE, NO_DEFER } m_defering; // Defering state char *m_defer_buffer; // Defering target buffer - size_t m_defer_nbytes; // Defering buffer size - wxTimer *m_defer_timer; // Timer for defering mode + wxUint32 m_defer_nbytes; // Defering buffer size + wxTimer *m_defer_timer; // Timer for defering mode - wxList m_states; // Stack of states + wxList m_states; // Stack of states public: wxSocketBase(); @@ -82,17 +120,17 @@ public: 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& Unread(const char *buffer, size_t nbytes); - wxSocketBase& ReadMsg(char *buffer, size_t nbytes); - wxSocketBase& WriteMsg(const char *buffer, size_t nbytes); + 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, size_t size); - void CreatePushbackBefore(const char *buffer, size_t size); + // Try not to use these two methods (they sould be protected) + void CreatePushbackAfter(const char *buffer, wxUint32 size); + void CreatePushbackBefore(const char *buffer, wxUint32 size); // Status inline bool Ok() const { return (m_socket != NULL); }; @@ -102,21 +140,21 @@ public: inline bool IsDisconnected() const { return !IsConnected(); }; inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); }; bool IsData() const; - inline size_t LastCount() const { return m_lcount; } - inline GSocketError LastError() const { return GSocket_GetError(m_socket); } + 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 SetFlags(wxSockFlags _flags); wxSockFlags GetFlags() const; - inline void SetTimeout(unsigned long sec) { m_timeout = sec; } + void SetTimeout(unsigned long 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); + // seconds, milliseconds = 0 means no wait + // seconds, milliseconds > 0 means specified wait + 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(); @@ -129,12 +167,12 @@ public: // Setup event handler void SetEventHandler(wxEvtHandler& evt_hdlr, int id = -1); - // Method called when it happens something on the socket - void SetNotify(GSocketEventFlags flags); - virtual void OnRequest(GSocketEvent req_evt); + // Method called when something happens in the socket + void SetNotify(wxSocketEventFlags flags); + virtual void OnRequest(wxSocketNotify req_evt); // Public internal callback - virtual void OldOnNotify(GSocketEvent WXUNUSED(evt)); + virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt)); // Some info on the socket... virtual bool GetPeer(wxSockAddress& addr_man) const; @@ -144,9 +182,9 @@ public: void Notify(bool notify); // So you can know what the socket driver is looking for ... - inline GSocketEventFlags NeededReq() const { return m_neededreq; } + inline wxSocketEventFlags NeededReq() const { return m_neededreq; } - static GSocketEventFlags EventToNotify(GSocketEvent evt); + static wxSocketEventFlags EventToNotify(wxSocketNotify evt); protected: friend class wxSocketServer; @@ -163,14 +201,14 @@ public: protected: #endif - bool _Wait(long seconds, long microseconds, int type); + bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags); - int DeferRead(char *buffer, size_t nbytes); - int DeferWrite(const char *buffer, size_t nbytes); - void DoDefer(GSocketEvent evt); + int DeferRead(char *buffer, wxUint32 nbytes); + int DeferWrite(const char *buffer, wxUint32 nbytes); + void DoDefer(); // Pushback library - size_t GetPushback(char *buffer, size_t size, bool peek); + wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek); }; //////////////////////////////////////////////////////////////////////// @@ -184,8 +222,10 @@ public: wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE); - wxSocketBase* Accept(); - bool AcceptWith(wxSocketBase& sock); + wxSocketBase* Accept(bool wait = TRUE); + bool AcceptWith(wxSocketBase& sock, bool wait = TRUE); + + bool WaitOnAccept(long seconds = -1, long milliseconds = 0); }; //////////////////////////////////////////////////////////////////////// @@ -200,9 +240,9 @@ public: virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE); - bool WaitOnConnect(long seconds = -1, long microseconds = 0); + bool WaitOnConnect(long seconds = -1, long milliseconds = 0); - virtual void OnRequest(GSocketEvent flags); + virtual void OnRequest(wxSocketNotify flags); }; class WXDLLEXPORT wxSocketEvent : public wxEvent { @@ -210,13 +250,13 @@ class WXDLLEXPORT wxSocketEvent : public wxEvent { public: wxSocketEvent(int id = 0); - GSocketEvent SocketEvent() const { return m_skevt; } + wxSocketNotify SocketEvent() const { return m_skevt; } wxSocketBase *Socket() const { return m_socket; } void CopyObject(wxObject& obj_d) const; public: - GSocketEvent m_skevt; + wxSocketNotify m_skevt; wxSocketBase *m_socket; };