X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/82a5f02c861e8d57ba8255a9553b941118ad4520..09f0f2cf08fd9924c103184c52833146a1d008d4:/include/wx/socket.h diff --git a/include/wx/socket.h b/include/wx/socket.h index a8a9ff7c02..056de5ee5a 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 @@ -79,7 +70,10 @@ enum wxSOCKET_NONE = 0, wxSOCKET_NOWAIT = 1, wxSOCKET_WAITALL = 2, - wxSOCKET_BLOCK = 4 + wxSOCKET_BLOCK = 4, + wxSOCKET_REUSEADDR = 8, + wxSOCKET_BROADCAST = 16, + wxSOCKET_NOBIND = 32 }; enum wxSocketType @@ -94,43 +88,15 @@ enum wxSocketType typedef int wxSocketFlags; -#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 - }; - - typedef void (*wxSockCbk)(wxSocketBase& sock, wxSocketNotify evt, char *cdata); -#endif // WXWIN_COMPATIBILITY - public: // Public interface @@ -144,19 +110,22 @@ public: bool Destroy(); // state - inline bool Ok() 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); } + bool Ok() const { return IsOk(); } + bool IsOk() const { return (m_socket != NULL); } + bool Error() const { return m_error; } + bool IsClosed() const { return m_closed; } + bool IsConnected() const { return m_connected; } + bool IsData() { return WaitForRead(0, 0); } + bool IsDisconnected() const { return !IsConnected(); } + wxUint32 LastCount() const { return m_lcount; } + 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(const wxIPV4address& local); // base IO virtual bool Close(); @@ -168,28 +137,31 @@ public: wxSocketBase& Write(const void *buffer, wxUint32 nbytes); wxSocketBase& WriteMsg(const void *buffer, wxUint32 nbytes); - void InterruptWait() { m_interrupt = TRUE; }; + 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; } + 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); + 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 = -1); + void SetEventHandler(wxEvtHandler& handler, int id = wxID_ANY); void SetNotify(wxSocketEventFlags flags); void Notify(bool notify); - // callbacks are deprecated, use events instead -#if WXWIN_COMPATIBILITY - wxSockCbk Callback(wxSockCbk cbk_); - char *CallbackData(char *data); -#endif // WXWIN_COMPATIBILITY + // initialize/shutdown the sockets (usually called automatically) + static bool IsInitialized(); + static bool Initialize(); + static void Shutdown(); // Implementation from now on @@ -199,8 +171,8 @@ public: void OnRequest(wxSocketNotify notify); // do not use, not documented nor supported - inline bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); } - inline wxSocketType GetType() const { return m_type; } + bool IsNoWait() const { return ((m_flags & wxSOCKET_NOWAIT) != 0); } + wxSocketType GetType() const { return m_type; } private: friend class wxSocketClient; @@ -228,12 +200,14 @@ 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) + bool m_closed; // was the other end closed? + // (notice that m_error is also set then) 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 @@ -247,11 +221,10 @@ private: bool m_notify; // notify events to users? wxSocketEventFlags m_eventmask; // which events to notify? - // callbacks are deprecated, use events instead -#if WXWIN_COMPATIBILITY - wxSockCbk m_cbk; // callback - char *m_cdata; // callback data -#endif // WXWIN_COMPATIBILITY + // the initialization count, GSocket is initialized if > 0 + static size_t m_countInit; + + DECLARE_NO_COPY_CLASS(wxSocketBase) }; @@ -259,17 +232,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) }; @@ -277,7 +252,7 @@ public: // wxSocketClient // -------------------------------------------------------------------------- -class WXDLLEXPORT wxSocketClient : public wxSocketBase +class WXDLLIMPEXP_NET wxSocketClient : public wxSocketBase { DECLARE_CLASS(wxSocketClient) @@ -285,9 +260,30 @@ public: wxSocketClient(wxSocketFlags flags = wxSOCKET_NONE); virtual ~wxSocketClient(); - virtual bool Connect(wxSockAddress& addr, bool wait = TRUE); + virtual bool Connect(const wxSockAddress& addr, bool wait = true); + bool Connect(const wxSockAddress& addr, const wxSockAddress& local, + bool wait = true); bool WaitOnConnect(long seconds = -1, long milliseconds = 0); + + // 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(const wxSockAddress& addr, + const wxSockAddress* local, + bool wait = true); + + // buffer sizes, -1 if unset and defaults should be used + int m_initialRecvBufferSize; + int m_initialSendBufferSize; + + DECLARE_NO_COPY_CLASS(wxSocketClient) }; @@ -297,23 +293,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, void* buf, wxUint32 nBytes ); - wxDatagramSocket& SendTo( wxSockAddress& addr, + wxDatagramSocket& SendTo( const wxSockAddress& addr, const void* buf, wxUint32 nBytes ); /* TODO: bool Connect(wxSockAddress& addr); */ + DECLARE_NO_COPY_CLASS(wxDatagramSocket) }; @@ -321,40 +318,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 GetSocketEvent() const { return m_event; } wxSocketBase *GetSocket() const { return (wxSocketBase *) GetEventObject(); } void *GetClientData() const { return m_clientData; } - // backwards compatibility -#if WXWIN_COMPATIBILITY_2 - wxSocketNotify SocketEvent() const { return m_event; } - wxSocketBase *Socket() const { return (wxSocketBase *) GetEventObject(); } -#endif // WXWIN_COMPATIBILITY_2 - - void CopyObject(wxObject& object_dest) const; + virtual wxEvent *Clone() const { return new wxSocketEvent(*this); } public: wxSocketNotify m_event; void *m_clientData; + + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxSocketEvent) }; typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&); -#define EVT_SOCKET(id, func) wxEventTableEntry( 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