/////////////////////////////////////////////////////////////////////////////
// Name: socket.h
// Purpose: Socket handling classes
-// Author: Guilhem Lavaux
+// Authors: Guilhem Lavaux, Guillermo Rodriguez Garcia
// Modified by:
// Created: April 1997
// RCS-ID: $Id$
// ---------------------------------------------------------------------------
// wxSocket headers (generic)
// ---------------------------------------------------------------------------
+
#ifdef WXPREC
# include "wx/wxprec.h"
#else
#include "wx/sckaddr.h"
#include "wx/gsocket.h"
+// ------------------------------------------------------------------------
+// constants
+// ------------------------------------------------------------------------
+
+enum wxSocketNotify
+{
+ wxSOCKET_INPUT = GSOCK_INPUT,
+ wxSOCKET_OUTPUT = GSOCK_OUTPUT,
+ wxSOCKET_CONNECTION = GSOCK_CONNECTION,
+ wxSOCKET_LOST = GSOCK_LOST
+};
+
+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
+};
+
+typedef GSocketEventFlags wxSocketEventFlags;
+
+enum wxSocketError
+{
+ wxSOCKET_NOERROR = GSOCK_NOERROR,
+ wxSOCKET_INPOP = 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_TIMEDOUT = GSOCK_TIMEDOUT,
+ wxSOCKET_MEMERR = GSOCK_MEMERR,
+ wxSOCKET_BUSY
+};
+
+enum
+{
+ wxSOCKET_NONE = 0,
+ wxSOCKET_NOWAIT = 1,
+ wxSOCKET_WAITALL = 2,
+ wxSOCKET_BLOCK = 4
+};
+
+// Type of socket
+enum wxSockType
+{
+ SOCK_CLIENT,
+ SOCK_SERVER,
+ SOCK_DATAGRAM,
+ SOCK_INTERNAL,
+ SOCK_UNINIT
+};
+
+typedef int wxSockFlags;
+
+// ------------------------------------------------------------------------
+// wxSocket base
+// ------------------------------------------------------------------------
+
class WXDLLEXPORT wxTimer;
class WXDLLEXPORT wxSocketEvent;
+
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,GSocketEvent 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
- GSocketEventFlags 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
-
- bool m_connected; // Connected ?
- 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
- size_t m_defer_nbytes; // Defering buffer size
- wxTimer *m_defer_timer; // Timer for defering mode
-
- wxList m_states; // Stack of states
+ GSocket *m_socket; // GSocket
+ wxEvtHandler *m_evt_handler; // event handler
+ int m_id; // Socket id (for event handler)
+
+ // Attributes
+ wxSockFlags m_flags; // wxSocket flags
+ wxSockType m_type; // wxSocket type
+ wxSocketEventFlags m_neededreq; // Event mask
+ bool m_notify_state; // Notify events to users?
+
+ // State
+ 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
+ bool m_interrupt; // Interrupt ongoing wait operations
+
+ // Pushback buffer
+ char *m_unread; // Pushback buffer
+ wxUint32 m_unrd_size; // Pushback buffer size
+ wxUint32 m_unrd_cur; // Pushback pointer (index into buffer)
+
+ // Callback
+ wxSockCbk m_cbk; // C callback
+ char *m_cdata; // C callback data
public:
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);
+ wxSocketBase& Peek(char* buffer, wxUint32 nbytes);
+ wxSocketBase& Read(char* buffer, wxUint32 nbytes);
+ wxSocketBase& Write(const char *buffer, wxUint32 nbytes);
+ wxSocketBase& Unread(const char *buffer, wxUint32 nbytes);
+ wxSocketBase& ReadMsg(char *buffer, wxUint32 nbytes);
+ wxSocketBase& WriteMsg(const char *buffer, wxUint32 nbytes);
+ 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 size_t LastCount() const { return m_lcount; }
- inline GSocketError LastError() const { return GSocket_GetError(m_socket); }
+ 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;
- inline void SetTimeout(unsigned long sec) { m_timeout = sec; }
+ // Addresses
+ virtual bool GetPeer(wxSockAddress& addr_man) const;
+ virtual bool GetLocal(wxSockAddress& addr_man) const;
- // 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);
+ // Set attributes and flags
+ void SetTimeout(long seconds);
+ void SetFlags(wxSockFlags flags);
+ inline wxSockFlags GetFlags() const { return m_flags; };
+
+ /* 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);
+ bool WaitForLost(long seconds = -1, long milliseconds = 0);
+
+ /* This function interrupts all ongoing wait operations for this
+ * socket; use it only as an escape mechanism (for example to close
+ * an app or to abort an operation). Reception of LOST events and
+ * calls to Close() automatically call this.
+ */
+ void InterruptAllWaits() { m_interrupt = TRUE; };
// Save the current state of Socket
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
- void SetNotify(GSocketEventFlags flags);
- virtual void OnRequest(GSocketEvent req_evt);
-
- // Public internal callback
- virtual void OldOnNotify(GSocketEvent 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
+ // Tell wxSocket which events to notify
+ void SetNotify(wxSocketEventFlags flags);
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);
- // So you can know what the socket driver is looking for ...
- inline GSocketEventFlags NeededReq() const { return m_neededreq; }
+ // Public internal callback
+ virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt));
- static GSocketEventFlags EventToNotify(GSocketEvent 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:
protected:
#endif
- bool _Wait(long seconds, long microseconds, 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, size_t nbytes);
- int DeferWrite(const char *buffer, size_t nbytes);
- void DoDefer(GSocketEvent evt);
-
- // Pushback library
- size_t GetPushback(char *buffer, size_t size, bool peek);
+ // Pushbacks
+ void Pushback(const char *buffer, wxUint32 size);
+ wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);
};
////////////////////////////////////////////////////////////////////////
{
DECLARE_CLASS(wxSocketServer)
public:
-
// 'service' can be a name or a port-number
- wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSocketBase::NONE);
+ wxSocketServer(wxSockAddress& addr_man, wxSockFlags flags = wxSOCKET_NONE);
+
+ wxSocketBase* Accept(bool wait = TRUE);
+ bool AcceptWith(wxSocketBase& sock, bool wait = TRUE);
- wxSocketBase* Accept();
- bool AcceptWith(wxSocketBase& sock);
+ bool WaitForAccept(long seconds = -1, long milliseconds = 0);
};
////////////////////////////////////////////////////////////////////////
DECLARE_CLASS(wxSocketClient)
public:
- wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
+ wxSocketClient(wxSockFlags flags = wxSOCKET_NONE);
virtual ~wxSocketClient();
virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
- bool WaitOnConnect(long seconds = -1, long microseconds = 0);
+ bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
+};
+
+////////////////////////////////////////////////////////////////////////
- virtual void OnRequest(GSocketEvent flags);
+class wxDatagramSocket : public wxSocketBase
+{
+ DECLARE_CLASS(wxDatagramSocket)
+
+public:
+ wxDatagramSocket( wxSockAddress& addr, wxSockFlags flags = wxSOCKET_NONE );
+
+ wxDatagramSocket& RecvFrom( wxSockAddress& addr,
+ char* buf,
+ wxUint32 nBytes );
+ wxDatagramSocket& SendTo( wxSockAddress& addr,
+ const char* buf,
+ wxUint32 nBytes );
};
+////////////////////////////////////////////////////////////////////////
+
class WXDLLEXPORT wxSocketEvent : public wxEvent {
DECLARE_DYNAMIC_CLASS(wxSocketEvent)
public:
wxSocketEvent(int id = 0);
- GSocketEvent SocketEvent() const { return m_skevt; }
+ wxSocketNotify SocketEvent() const { return m_skevt; }
wxSocketBase *Socket() const { return m_socket; }
void CopyObject(wxObject& obj_d) const;
public:
- GSocketEvent m_skevt;
+ wxSocketNotify m_skevt;
wxSocketBase *m_socket;
};
projects / wxWidgets.git / blobdiff