X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/35809fe3d75970b18aea9ff6c753ff9b41bd325e..252a752e85d42d81f2c55e128ab3bd9c6fd70c51:/include/wx/socket.h?ds=inline diff --git a/include/wx/socket.h b/include/wx/socket.h index da40262dc9..bc9a2c6487 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$ @@ -23,6 +23,7 @@ // --------------------------------------------------------------------------- // wxSocket headers (generic) // --------------------------------------------------------------------------- + #ifdef WXPREC # include "wx/wxprec.h" #else @@ -34,17 +35,19 @@ #include "wx/gsocket.h" // ------------------------------------------------------------------------ -// GSocket type alias +// 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,7 +56,8 @@ enum { typedef GSocketEventFlags wxSocketEventFlags; -typedef enum { +enum wxSocketError +{ wxSOCKET_NOERROR = GSOCK_NOERROR, wxSOCKET_INPOP = GSOCK_INVOP, wxSOCKET_IOERR = GSOCK_IOERR, @@ -63,8 +67,28 @@ typedef enum { wxSOCKET_INVPORT = GSOCK_INVPORT, wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK, wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT, - wxSOCKET_MEMERR = GSOCK_MEMERR -} wxSocketError; + wxSOCKET_MEMERR = GSOCK_MEMERR, + wxSOCKET_BUSY +}; + +enum +{ + wxSOCKET_NONE = 0, + wxSOCKET_NOWAIT = 1, + wxSOCKET_WAITALL = 2, + wxSOCKET_BLOCK = 4 +}; + +// Type of request +enum wxSockType +{ + SOCK_CLIENT, + SOCK_SERVER, + SOCK_INTERNAL, + SOCK_UNINIT +}; + +typedef int wxSockFlags; // ------------------------------------------------------------------------ // wxSocket base @@ -77,43 +101,61 @@ class WXDLLEXPORT wxSocketBase : public wxEvtHandler DECLARE_CLASS(wxSocketBase) public: - enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 }; - typedef int wxSockFlags; - // Type of request + enum + { + NONE = wxSOCKET_NONE, + NOWAIT = wxSOCKET_NOWAIT, + WAITALL = wxSOCKET_WAITALL, + SPEED = wxSOCKET_BLOCK + }; - enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT }; - typedef void (*wxSockCbk)(wxSocketBase& sock,wxSocketNotify evt,char *cdata); + typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata); protected: - GSocket *m_socket; // wxSocket socket + GSocket *m_socket; // GSocket + int m_id; // Socket id (for event handler) + + // Attributes 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 + wxSocketEventFlags m_neededreq; // Event mask + bool m_notify_state; // Notify events to users? + 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 ? + wxUint32 m_lcount; // Last IO transaction size unsigned long m_timeout; // IO timeout value - + wxList m_states; // Stack of states + char *m_unread; // Pushback buffer wxUint32 m_unrd_size; // Pushback buffer size - wxUint32 m_unrd_cur; // Pushback pointer + wxUint32 m_unrd_cur; // Pushback pointer (index into buffer) + + // Async IO variables + enum + { + NO_DEFER = 0, + DEFER_READ = 1, + DEFER_WRITE = 2 + } 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 + +/* + char *m_read_buffer; // Target buffer (read) + char *m_write_buffer; // Target buffer (write) + wxUint32 m_read_nbytes; // Buffer size (read) + wxUint32 m_write_nbytes; // Buffer size (write) + wxTimer *m_read_timer; // Timer (read) + wxTimer *m_write_timer; // Timer (write) +*/ wxSockCbk m_cbk; // C callback char *m_cdata; // C callback data - bool m_connected; // Connected ? - bool m_establishing; // Pending connections? - bool m_notify_state; // Notify state - 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 - wxUint32 m_defer_nbytes; // Defering buffer size - wxTimer *m_defer_timer; // Timer for defering mode - - wxList m_states; // Stack of states - public: wxSocketBase(); virtual ~wxSocketBase(); @@ -126,31 +168,32 @@ public: 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 these two methods (they sould be protected) - void CreatePushbackAfter(const char *buffer, wxUint32 size); - void CreatePushbackBefore(const char *buffer, wxUint32 size); + wxSocketBase& Discard(); // Status 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 IsDisconnected() const { return !IsConnected(); }; inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); }; - bool IsData() const; + inline bool IsData() { return WaitForRead(0, 0); }; 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; - void SetTimeout(unsigned long sec); + // Some info on the socket... + virtual bool GetPeer(wxSockAddress& addr_man) const; + virtual bool GetLocal(wxSockAddress& addr_man) const; + + // Set attributes and flags + void SetTimeout(long seconds); + void SetFlags(wxSockFlags flags); + inline wxSockFlags GetFlags() const { return m_flags; }; - // seconds = -1 means infinite wait - // seconds, milliseconds = 0 means no wait - // seconds, milliseconds > 0 means specified wait + // Wait functions + // seconds = -1 means default timeout (change with SetTimeout) + // 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); @@ -160,36 +203,29 @@ public: 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 + // Tell wxSocket which events to notify void SetNotify(wxSocketEventFlags flags); - virtual void OnRequest(wxSocketNotify req_evt); + void Notify(bool notify); + static wxSocketEventFlags EventToNotify(wxSocketNotify evt); + inline wxSocketEventFlags NeededReq() const { return m_neededreq; } + + // External callback + wxSockCbk Callback(wxSockCbk cbk_); + char *CallbackData(char *data); // 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); + // Do NOT use this function; it should be protected! + void OnRequest(wxSocketNotify req_evt); protected: friend class wxSocketServer; + friend class wxSocketClient; friend class wxSocketHandler; - friend class wxSocketInternal; #ifdef __SALFORDC__ public: @@ -201,13 +237,17 @@ public: protected: #endif - bool _Wait(long seconds, long milliseconds, int type); + // Low level IO + wxUint32 _Read(char* buffer, wxUint32 nbytes); + wxUint32 _Write(const char *buffer, wxUint32 nbytes); + bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags); - int DeferRead(char *buffer, wxUint32 nbytes); - int DeferWrite(const char *buffer, wxUint32 nbytes); - void DoDefer(wxSocketNotify evt); + wxUint32 DeferRead(char *buffer, wxUint32 nbytes); + wxUint32 DeferWrite(const char *buffer, wxUint32 nbytes); + void DoDefer(); - // Pushback library + // Pushbacks + void Pushback(const char *buffer, wxUint32 size); wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek); }; @@ -217,7 +257,6 @@ class WXDLLEXPORT wxSocketServer : public wxSocketBase { DECLARE_CLASS(wxSocketServer) public: - // 'service' can be a name or a port-number wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE); @@ -225,7 +264,7 @@ public: wxSocketBase* Accept(bool wait = TRUE); bool AcceptWith(wxSocketBase& sock, bool wait = TRUE); - bool WaitOnAccept(long seconds = -1, long milliseconds = 0); + bool WaitForAccept(long seconds = -1, long milliseconds = 0); }; //////////////////////////////////////////////////////////////////////// @@ -241,8 +280,6 @@ public: virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE); bool WaitOnConnect(long seconds = -1, long milliseconds = 0); - - virtual void OnRequest(wxSocketNotify flags); }; class WXDLLEXPORT wxSocketEvent : public wxEvent {