X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fbf5995c0270231195b1d7abd48e72b8bf2ea2d2..687b91d266990129fbbb8c21d92fa4298b458352:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index 33726e4a78..ee2578f3c2 100644 --- a/include/wx/socket.h +++ b/include/wx/socket.h @@ -9,12 +9,8 @@ // 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" @@ -24,15 +20,10 @@ // 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" // ------------------------------------------------------------------------ // Types and constants @@ -58,8 +49,9 @@ typedef GSocketEventFlags wxSocketEventFlags; 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, @@ -67,7 +59,10 @@ enum wxSocketError wxSOCKET_INVPORT = GSOCK_INVPORT, wxSOCKET_WOULDBLOCK = GSOCK_WOULDBLOCK, wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT, - wxSOCKET_MEMERR = GSOCK_MEMERR + wxSOCKET_MEMERR = GSOCK_MEMERR, + + // wxSocket-specific (not yet implemented) + wxSOCKET_DUMMY }; enum @@ -75,10 +70,10 @@ enum wxSOCKET_NONE = 0, wxSOCKET_NOWAIT = 1, wxSOCKET_WAITALL = 2, - wxSOCKET_BLOCK = 4 + wxSOCKET_BLOCK = 4, + wxSOCKET_REUSEADDR = 8 }; -// Type of socket enum wxSocketType { wxSOCKET_UNINIT, @@ -91,46 +86,15 @@ enum wxSocketType typedef int wxSocketFlags; -// old names - -#if WXWIN_COMPATIBILITY - -typedef wxSocketType wxSockType; -typedef wxSocketFlags wxSockFlags; - -#endif // WXWIN_COMPATIBILITY // -------------------------------------------------------------------------- // wxSocketBase // -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketBase : public wxObject +class WXDLLIMPEXP_NET wxSocketBase : public wxObject { DECLARE_CLASS(wxSocketBase) -public: - -#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 - }; -#endif // WXWIN_COMPATIBILITY - - typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata); - public: // Public interface @@ -144,58 +108,67 @@ public: bool Destroy(); // state - inline bool Ok() const { return (m_socket != NULL); }; + 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)GSocket_GetError(m_socket); } + inline wxSocketError LastError() const { return (wxSocketError)m_socket->GetError(); } void SaveState(); void RestoreState(); // 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(char* buffer, wxUint32 nbytes); - wxSocketBase& Read(char* buffer, wxUint32 nbytes); - wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes); - wxSocketBase& Unread(const char *buffer, wxUint32 nbytes); - wxSocketBase& Write(const char *buffer, wxUint32 nbytes); - wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes); - - void InterruptAllWaits() { m_interrupt = TRUE; }; + 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; }; + 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 SetEventHandler(wxEvtHandler& handler, int id = -1); + 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); void Notify(bool notify); - // callbacks - deprecated, avoid if possible - wxSockCbk Callback(wxSockCbk cbk_); - char *CallbackData(char *data); + // initialize/shutdown the sockets (usually called automatically) + static bool IsInitialized(); + static bool Initialize(); + static void Shutdown(); // Implementation from now on // -------------------------- - // do not use, this should be private - void OnRequest(wxSocketNotify req_evt); + // do not use, should be private (called from GSocket) + void OnRequest(wxSocketNotify notify); // do not use, not documented nor supported - inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); }; + inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); } inline wxSocketType GetType() const { return m_type; } private: @@ -204,15 +177,16 @@ private: friend class wxDatagramSocket; // low level IO - wxUint32 _Read(char* buffer, wxUint32 nbytes); - wxUint32 _Write(const char *buffer, wxUint32 nbytes); - bool _Wait(long seconds, long milliseconds, wxSocketEventFlags flags); + 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 char *buffer, wxUint32 size); - wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek); + 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 @@ -223,25 +197,30 @@ private: 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 - char *m_unread; // pushback buffer + void *m_unread; // pushback buffer wxUint32 m_unrd_size; // pushback buffer size wxUint32 m_unrd_cur; // pushback pointer (index into buffer) // events - wxEvtHandler *m_handler; // event handler int m_id; // socket id - bool m_notify_state; // notify events to users? - wxSocketEventFlags - m_neededreq; // event mask - wxSockCbk m_cbk; // callback - char *m_cdata; // callback data + 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) }; @@ -249,17 +228,19 @@ private: // wxSocketServer // -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketServer : public wxSocketBase +class WXDLLIMPEXP_NET wxSocketServer : public wxSocketBase { DECLARE_CLASS(wxSocketServer) public: - wxSocketServer(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); + wxSocketServer(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); - wxSocketBase* Accept(bool wait = TRUE); - bool AcceptWith(wxSocketBase& socket, bool wait = TRUE); + wxSocketBase* Accept(bool wait = true); + bool AcceptWith(wxSocketBase& socket, bool wait = true); bool WaitForAccept(long seconds = -1, long milliseconds = 0); + + DECLARE_NO_COPY_CLASS(wxSocketServer) }; @@ -267,7 +248,7 @@ public: // wxSocketClient // -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketClient : public wxSocketBase +class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase { DECLARE_CLASS(wxSocketClient) @@ -275,9 +256,15 @@ public: wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE); virtual ~wxSocketClient(); - virtual bool Connect(wxSockAddress& addr, bool wait = TRUE); + virtual bool Connect(wxSockAddress& addr, bool wait = true); + bool Connect(wxSockAddress& addr, wxSockAddress& local, bool wait = true); bool WaitOnConnect(long seconds = -1, long milliseconds = 0); + +private: + virtual bool DoConnect(wxSockAddress& addr, wxSockAddress* local, bool wait = true); + + DECLARE_NO_COPY_CLASS(wxSocketClient) }; @@ -287,19 +274,24 @@ public: // WARNING: still in alpha stage -class wxDatagramSocket : public wxSocketBase +class WXDLLIMPEXP_NET wxDatagramSocket : public wxSocketBase { DECLARE_CLASS(wxDatagramSocket) public: - wxDatagramSocket(wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); + wxDatagramSocket(const wxSockAddress& addr, wxSocketFlags flags = wxSOCKET_NONE); wxDatagramSocket& RecvFrom( wxSockAddress& addr, - char* buf, + void* buf, wxUint32 nBytes ); - wxDatagramSocket& SendTo( wxSockAddress& addr, - const char* buf, + wxDatagramSocket& SendTo( const wxSockAddress& addr, + const void* buf, wxUint32 nBytes ); + +/* TODO: + bool Connect(wxSockAddress& addr); +*/ + DECLARE_NO_COPY_CLASS(wxDatagramSocket) }; @@ -307,33 +299,37 @@ public: // wxSocketEvent // -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketEvent : public wxEvent +class WXDLLIMPEXP_NET wxSocketEvent : public wxEvent { - DECLARE_DYNAMIC_CLASS(wxSocketEvent) - public: - wxSocketEvent(int id = 0); + wxSocketEvent(int id = 0) + : wxEvent(id, wxEVT_SOCKET) + { + } - wxSocketNotify SocketEvent() const { return m_event; } - 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& object_dest) const; + virtual wxEvent *Clone() const { return new wxSocketEvent(*this); } public: wxSocketNotify m_event; - wxSocketBase *m_socket; + 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