X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/feeb8165970889f393d4a1bf2dae2a1505fd5e4c..a6f989f3dbec747c6da629a32fa5cad9a554f66e:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index 9103aeb2f2..d74c44d296 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$ @@ -82,36 +82,38 @@ public: // Type of request 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 wxSockFlags m_flags; // wxSocket flags wxSockType m_type; // wxSocket type - wxSocketEventFlags m_neededreq; // Specify which requet signals we need + 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 + + 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 + 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 - wxUint32 m_defer_nbytes; // Defering buffer size - wxTimer *m_defer_timer; // Timer for defering mode + } 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 + bool m_error; // Did an error occur in last IO call ? + wxList m_states; // Stack of states public: wxSocketBase(); @@ -127,14 +129,9 @@ public: 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 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); }; @@ -143,13 +140,19 @@ public: inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); } inline wxSockType GetType() const { return m_type; } + // Some info on the socket... + virtual bool GetPeer(wxSockAddress& addr_man) const; + virtual bool GetLocal(wxSockAddress& addr_man) const; + + // Set attributes and flags void SetFlags(wxSockFlags _flags); wxSockFlags GetFlags() const; - void SetTimeout(unsigned long sec); + void SetTimeout(long seconds); - // seconds = -1 means infinite wait - // seconds = 0 means no wait - // seconds > 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); @@ -159,36 +162,31 @@ 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 these functions; they should be protected! + void CreatePushbackAfter(const char *buffer, wxUint32 size); + void CreatePushbackBefore(const char *buffer, wxUint32 size); + void OnRequest(wxSocketNotify req_evt); protected: friend class wxSocketServer; + friend class wxSocketClient; friend class wxSocketHandler; - friend class wxSocketInternal; #ifdef __SALFORDC__ public: @@ -200,11 +198,11 @@ public: protected: #endif - bool _Wait(long seconds, long milliseconds, int type); + 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); + void DoDefer(); // Pushback library wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek); @@ -216,13 +214,14 @@ 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); - wxSocketBase* Accept(); - bool AcceptWith(wxSocketBase& sock); + wxSocketBase* Accept(bool wait = TRUE); + bool AcceptWith(wxSocketBase& sock, bool wait = TRUE); + + bool WaitForAccept(long seconds = -1, long milliseconds = 0); }; //////////////////////////////////////////////////////////////////////// @@ -238,8 +237,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 {