X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/de3131e78406c3d8a4fb5c1fdf91fbeccfe63f73..13d4419b86d028b3e7e32b0f94cc45c40dd9551c:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index ba17e64804..5e9e687b3e 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$ @@ -9,262 +9,342 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef _WX_NETWORK_SOCKET_H -#define _WX_NETWORK_SOCKET_H - -#ifdef __GNUG__ -#pragma interface "socket.h" -#endif +#ifndef _WX_SOCKET_H_ +#define _WX_SOCKET_H_ #include "wx/defs.h" #if wxUSE_SOCKETS // --------------------------------------------------------------------------- -// wxSocket headers (generic) +// wxSocket headers // --------------------------------------------------------------------------- -#ifdef WXPREC -# include "wx/wxprec.h" -#else -# include "wx/event.h" -# include "wx/string.h" -#endif +#include "wx/event.h" #include "wx/sckaddr.h" #include "wx/gsocket.h" +#include "wx/list.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, - wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG, + wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG }; 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, wxSOCKET_NOHOST = GSOCK_NOHOST, wxSOCKET_INVPORT = GSOCK_INVPORT, wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK, - wxSOCKET_TIMEOUT = GSOCK_TIMEOUT, - wxSOCKET_MEMERR = GSOCK_MEMERR -} wxSocketError; + wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT, + 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, + wxSOCKET_REUSEADDR = 8, + wxSOCKET_BROADCAST = 16, + wxSOCKET_NOBIND = 32 +}; - enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 }; - typedef int wxSockFlags; - // Type of request +enum wxSocketType +{ + wxSOCKET_UNINIT, + wxSOCKET_CLIENT, + wxSOCKET_SERVER, + wxSOCKET_BASE, + wxSOCKET_DATAGRAM +}; - enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT }; - typedef void (*wxSockCbk)(wxSocketBase& sock,wxSocketNotify evt,char *cdata); +typedef int wxSocketFlags; -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 - size_t m_lcount; // Last IO request size - unsigned long m_timeout; // IO timeout value - 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 +// -------------------------------------------------------------------------- +// wxSocketBase +// -------------------------------------------------------------------------- - bool m_connected; // Connected ? - bool m_notify_state; // Notify state - int m_id; // Socket id (for event handler) +class WXDLLIMPEXP_NET 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 - size_t m_defer_nbytes; // Defering buffer size - wxTimer *m_defer_timer; // Timer for defering mode +public: - wxList m_states; // Stack of states + // 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& Unread(const char *buffer, size_t nbytes); - wxSocketBase& ReadMsg(char *buffer, size_t nbytes); - wxSocketBase& WriteMsg(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_socket != NULL); }; - inline bool Error() const - { return (GSocket_GetError(m_socket) != GSOCK_NOERROR); }; - 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 size_t 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; } - - // 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 + void Init(); + bool Destroy(); + + // state + inline bool Ok() const { return IsOk(); } + inline bool IsOk() 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 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 + // addresses + virtual bool GetLocal(wxSockAddress& addr_man) const; + virtual bool GetPeer(wxSockAddress& addr_man) const; + virtual bool SetLocal(wxIPV4address& local); + + // 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); - virtual void OnRequest(wxSocketNotify req_evt); + void Notify(bool notify); - // Public internal callback - virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt)); + // initialize/shutdown the sockets (usually called automatically) + static bool IsInitialized(); + static bool Initialize(); + static void Shutdown(); - // 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); + // Implementation from now on + // -------------------------- - // So you can know what the socket driver is looking for ... - inline wxSocketEventFlags NeededReq() const { return m_neededreq; } + // do not use, should be private (called from GSocket) + void OnRequest(wxSocketNotify notify); - static wxSocketEventFlags EventToNotify(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; } -protected: +private: + friend class wxSocketClient; friend class wxSocketServer; - friend class wxSocketHandler; - friend class wxSocketInternal; + 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? + wxIPV4address m_localAddress; // bind to local address? + + // 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) +}; -#ifdef __SALFORDC__ -public: -#endif - wxSocketBase(wxSockFlags flags, wxSockType type); +// -------------------------------------------------------------------------- +// wxSocketServer +// -------------------------------------------------------------------------- -#ifdef __SALFORDC__ -protected: -#endif +class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase +{ + DECLARE_CLASS(wxSocketServer) + +public: + wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); - bool _Wait(long seconds, long microseconds, int type); + wxSocketBase* Accept(bool wait = true); + bool AcceptWith(wxSocketBase& socket, bool wait = true); - int DeferRead(char *buffer, size_t nbytes); - int DeferWrite(const char *buffer, size_t nbytes); - void DoDefer(wxSocketNotify evt); + bool WaitForAccept(long seconds = -1, long milliseconds = 0); - // Pushback library - size_t GetPushback(char *buffer, size_t size, bool peek); + DECLARE_NO_COPY_CLASS(wxSocketServer) }; -//////////////////////////////////////////////////////////////////////// -class WXDLLEXPORT wxSocketServer : public wxSocketBase +// -------------------------------------------------------------------------- +// wxSocketClient +// -------------------------------------------------------------------------- + +class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase { - DECLARE_CLASS(wxSocketServer) + DECLARE_CLASS(wxSocketClient) + public: + wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE); + virtual ~wxSocketClient(); - // 'service' can be a name or a port-number + virtual bool Connect(wxSockAddress& addr, bool wait = true); + bool Connect(wxSockAddress& addr, wxSockAddress& local, bool wait = true); - wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE); + bool WaitOnConnect(long seconds = -1, long milliseconds = 0); - wxSocketBase* Accept(); - bool AcceptWith(wxSocketBase& sock); -}; + // Sets initial socket buffer sizes using the SO_SNDBUF and SO_RCVBUF options + // before calling connect (either one can be -1 to leave it unchanged) + void SetInitialSocketBuffers(int recv, int send) + { + m_initialRecvBufferSize = recv; + m_initialSendBufferSize = send; + } -//////////////////////////////////////////////////////////////////////// +private: + virtual bool + DoConnect(wxSockAddress& addr, wxSockAddress* local, bool wait = true); -class WXDLLEXPORT wxSocketClient : public wxSocketBase -{ - DECLARE_CLASS(wxSocketClient) -public: + // buffer sizes, -1 if unset and defaults should be used + int m_initialRecvBufferSize; + int m_initialSendBufferSize; - wxSocketClient(wxSockFlags flags = wxSocketBase::NONE); - virtual ~wxSocketClient(); + DECLARE_NO_COPY_CLASS(wxSocketClient) +}; - virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE); - bool WaitOnConnect(long seconds = -1, long microseconds = 0); +// -------------------------------------------------------------------------- +// wxDatagramSocket +// -------------------------------------------------------------------------- - virtual void OnRequest(wxSocketNotify flags); +// WARNING: still in alpha stage + +class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase +{ + DECLARE_CLASS(wxDatagramSocket) + +public: + wxDatagramSocket(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); + + wxDatagramSocket& RecvFrom( wxSockAddress& addr, + void* buf, + wxUint32 nBytes ); + wxDatagramSocket& SendTo( const 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 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; } - void CopyObject(wxObject& obj_d) const; + virtual wxEvent *Clone() const { return new wxSocketEvent(*this); } public: - wxSocketNotify m_skevt; - wxSocketBase *m_socket; + 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, -1, \ - (wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \ - (wxObject *) NULL }, +#define wxSocketEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxSocketEventFunction, &func) + +#define EVT_SOCKET(id, func) \ + wx__DECLARE_EVT1(wxEVT_SOCKET, id, wxSocketEventHandler(func)) + +#endif // wxUSE_SOCKETS -#endif - // wxUSE_SOCKETS +#endif // _WX_SOCKET_H_ -#endif - // _WX_NETWORK_SOCKET_H