1998-09-06 18:28:00 +00:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: socket.h
|
|
|
|
// Purpose: Socket handling classes
|
|
|
|
// Author: Guilhem Lavaux
|
|
|
|
// Modified by:
|
|
|
|
// Created: April 1997
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) Guilhem Lavaux
|
|
|
|
// Licence: wxWindows licence
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
1998-09-10 11:41:14 +00:00
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
#ifndef _WX_NETWORK_SOCKET_H
|
|
|
|
#define _WX_NETWORK_SOCKET_H
|
|
|
|
|
|
|
|
#ifdef __GNUG__
|
1998-09-10 11:41:14 +00:00
|
|
|
#pragma interface "socket.h"
|
1998-09-06 18:28:00 +00:00
|
|
|
#endif
|
|
|
|
|
1999-06-15 20:21:59 +00:00
|
|
|
#include "wx/defs.h"
|
|
|
|
|
|
|
|
#if wxUSE_SOCKETS
|
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
// wxSocket headers (generic)
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#ifdef WXPREC
|
1999-08-20 22:52:21 +00:00
|
|
|
# include "wx/wxprec.h"
|
1998-09-06 18:28:00 +00:00
|
|
|
#else
|
1999-08-20 22:52:21 +00:00
|
|
|
# include "wx/event.h"
|
|
|
|
# include "wx/string.h"
|
1998-09-06 18:28:00 +00:00
|
|
|
#endif
|
1999-06-26 11:56:44 +00:00
|
|
|
|
1999-08-20 22:52:21 +00:00
|
|
|
#include "wx/sckaddr.h"
|
1999-07-29 05:27:19 +00:00
|
|
|
#include "wx/gsocket.h"
|
1998-09-06 18:28:00 +00:00
|
|
|
|
1999-09-05 05:51:05 +00:00
|
|
|
// ------------------------------------------------------------------------
|
|
|
|
// GSocket type alias
|
|
|
|
// ------------------------------------------------------------------------
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
wxSOCKET_INPUT = GSOCK_INPUT,
|
|
|
|
wxSOCKET_OUTPUT = GSOCK_OUTPUT,
|
|
|
|
wxSOCKET_CONNECTION = GSOCK_CONNECTION,
|
|
|
|
wxSOCKET_LOST = GSOCK_LOST
|
|
|
|
} wxSocketNotify;
|
|
|
|
|
|
|
|
enum {
|
|
|
|
wxSOCKET_INPUT_FLAG = GSOCK_INPUT_FLAG,
|
|
|
|
wxSOCKET_OUTPUT_FLAG = GSOCK_OUTPUT_FLAG,
|
|
|
|
wxSOCKET_CONNECTION_FLAG = GSOCK_CONNECTION_FLAG,
|
1999-09-09 21:22:51 +00:00
|
|
|
wxSOCKET_LOST_FLAG = GSOCK_LOST_FLAG
|
1999-09-05 05:51:05 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef GSocketEventFlags wxSocketEventFlags;
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
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,
|
1999-09-05 10:23:22 +00:00
|
|
|
wxSOCKET_TIMEDOUT = GSOCK_TIMEDOUT,
|
1999-09-05 05:51:05 +00:00
|
|
|
wxSOCKET_MEMERR = GSOCK_MEMERR
|
|
|
|
} wxSocketError;
|
|
|
|
|
|
|
|
// ------------------------------------------------------------------------
|
|
|
|
// wxSocket base
|
|
|
|
// ------------------------------------------------------------------------
|
|
|
|
|
1999-07-30 17:54:18 +00:00
|
|
|
class WXDLLEXPORT wxTimer;
|
1998-09-06 18:28:00 +00:00
|
|
|
class WXDLLEXPORT wxSocketEvent;
|
|
|
|
class WXDLLEXPORT wxSocketBase : public wxEvtHandler
|
|
|
|
{
|
|
|
|
DECLARE_CLASS(wxSocketBase)
|
|
|
|
public:
|
|
|
|
|
1999-07-23 17:24:25 +00:00
|
|
|
enum { NONE=0, NOWAIT=1, WAITALL=2, SPEED=4 };
|
|
|
|
typedef int wxSockFlags;
|
1998-09-06 18:28:00 +00:00
|
|
|
// Type of request
|
|
|
|
|
1999-07-29 05:27:19 +00:00
|
|
|
enum wxSockType { SOCK_CLIENT, SOCK_SERVER, SOCK_INTERNAL, SOCK_UNINIT };
|
1999-09-05 05:51:05 +00:00
|
|
|
typedef void (*wxSockCbk)(wxSocketBase& sock,wxSocketNotify evt,char *cdata);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
protected:
|
1999-07-22 17:51:54 +00:00
|
|
|
GSocket *m_socket; // wxSocket socket
|
|
|
|
wxSockFlags m_flags; // wxSocket flags
|
1998-09-06 18:28:00 +00:00
|
|
|
wxSockType m_type; // wxSocket type
|
1999-09-05 06:46:38 +00:00
|
|
|
wxSocketEventFlags m_neededreq; // Specify which requet signals we need
|
1999-09-05 10:23:22 +00:00
|
|
|
wxUint32 m_lcount; // Last IO request size
|
1999-07-22 17:51:54 +00:00
|
|
|
unsigned long m_timeout; // IO timeout value
|
|
|
|
|
1999-04-26 18:16:56 +00:00
|
|
|
char *m_unread; // Pushback buffer
|
1999-09-05 10:23:22 +00:00
|
|
|
wxUint32 m_unrd_size; // Pushback buffer size
|
|
|
|
wxUint32 m_unrd_cur; // Pushback pointer
|
1999-07-22 17:51:54 +00:00
|
|
|
|
|
|
|
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)
|
|
|
|
|
1999-07-30 17:54:18 +00:00
|
|
|
// Defering variables
|
1999-07-22 17:51:54 +00:00
|
|
|
enum {
|
|
|
|
DEFER_READ, DEFER_WRITE, NO_DEFER
|
1999-07-30 17:54:18 +00:00
|
|
|
} m_defering; // Defering state
|
1999-07-22 17:51:54 +00:00
|
|
|
char *m_defer_buffer; // Defering target buffer
|
1999-09-05 10:23:22 +00:00
|
|
|
wxUint32 m_defer_nbytes; // Defering buffer size
|
1999-07-30 17:54:18 +00:00
|
|
|
wxTimer *m_defer_timer; // Timer for defering mode
|
1999-07-22 17:51:54 +00:00
|
|
|
|
|
|
|
wxList m_states; // Stack of states
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
public:
|
|
|
|
wxSocketBase();
|
|
|
|
virtual ~wxSocketBase();
|
|
|
|
virtual bool Close();
|
|
|
|
|
|
|
|
// Base IO
|
1999-09-05 10:23:22 +00:00
|
|
|
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);
|
1998-09-06 18:28:00 +00:00
|
|
|
void Discard();
|
|
|
|
|
|
|
|
// Try not to use this two methods (they sould be protected)
|
1999-09-05 10:23:22 +00:00
|
|
|
void CreatePushbackAfter(const char *buffer, wxUint32 size);
|
|
|
|
void CreatePushbackBefore(const char *buffer, wxUint32 size);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
// Status
|
1999-07-22 17:51:54 +00:00
|
|
|
inline bool Ok() const { return (m_socket != NULL); };
|
|
|
|
inline bool Error() const
|
|
|
|
{ return (GSocket_GetError(m_socket) != GSOCK_NOERROR); };
|
1998-09-06 18:28:00 +00:00
|
|
|
inline bool IsConnected() const { return m_connected; };
|
|
|
|
inline bool IsDisconnected() const { return !IsConnected(); };
|
1999-07-22 17:51:54 +00:00
|
|
|
inline bool IsNoWait() const { return ((m_flags & NOWAIT) != 0); };
|
1998-09-06 18:28:00 +00:00
|
|
|
bool IsData() const;
|
1999-09-05 10:23:22 +00:00
|
|
|
inline wxUint32 LastCount() const { return m_lcount; }
|
1999-09-05 05:51:05 +00:00
|
|
|
inline wxSocketError LastError() const { return (wxSocketError)GSocket_GetError(m_socket); }
|
1999-04-26 18:16:56 +00:00
|
|
|
inline wxSockType GetType() const { return m_type; }
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1999-03-01 13:06:15 +00:00
|
|
|
void SetFlags(wxSockFlags _flags);
|
1999-04-26 18:16:56 +00:00
|
|
|
wxSockFlags GetFlags() const;
|
1999-09-05 10:23:22 +00:00
|
|
|
void SetTimeout(unsigned long sec);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
// seconds = -1 means infinite wait
|
|
|
|
// seconds = 0 means no wait
|
|
|
|
// seconds > 0 means specified wait
|
1999-09-05 10:23:22 +00:00
|
|
|
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);
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
// 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);
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
// Method called when it happens something on the socket
|
1999-09-05 05:51:05 +00:00
|
|
|
void SetNotify(wxSocketEventFlags flags);
|
|
|
|
virtual void OnRequest(wxSocketNotify req_evt);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
// Public internal callback
|
1999-09-05 05:51:05 +00:00
|
|
|
virtual void OldOnNotify(wxSocketNotify WXUNUSED(evt));
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
// 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 ...
|
1999-09-05 05:51:05 +00:00
|
|
|
inline wxSocketEventFlags NeededReq() const { return m_neededreq; }
|
1998-09-06 18:28:00 +00:00
|
|
|
|
1999-09-05 05:51:05 +00:00
|
|
|
static wxSocketEventFlags EventToNotify(wxSocketNotify evt);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
friend class wxSocketServer;
|
|
|
|
friend class wxSocketHandler;
|
1999-04-26 18:16:56 +00:00
|
|
|
friend class wxSocketInternal;
|
1998-09-06 18:28:00 +00:00
|
|
|
|
1999-01-19 11:00:22 +00:00
|
|
|
#ifdef __SALFORDC__
|
|
|
|
public:
|
|
|
|
#endif
|
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
wxSocketBase(wxSockFlags flags, wxSockType type);
|
1999-01-19 11:00:22 +00:00
|
|
|
|
|
|
|
#ifdef __SALFORDC__
|
|
|
|
protected:
|
|
|
|
#endif
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1999-09-05 10:23:22 +00:00
|
|
|
bool _Wait(long seconds, long milliseconds, int type);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
1999-09-05 10:23:22 +00:00
|
|
|
int DeferRead(char *buffer, wxUint32 nbytes);
|
|
|
|
int DeferWrite(const char *buffer, wxUint32 nbytes);
|
1999-09-05 06:46:38 +00:00
|
|
|
void DoDefer(wxSocketNotify evt);
|
1999-07-29 05:27:19 +00:00
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
// Pushback library
|
1999-09-05 10:23:22 +00:00
|
|
|
wxUint32 GetPushback(char *buffer, wxUint32 size, bool peek);
|
1998-09-06 18:28:00 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
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);
|
|
|
|
};
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxSocketClient : public wxSocketBase
|
|
|
|
{
|
|
|
|
DECLARE_CLASS(wxSocketClient)
|
|
|
|
public:
|
|
|
|
|
|
|
|
wxSocketClient(wxSockFlags flags = wxSocketBase::NONE);
|
|
|
|
virtual ~wxSocketClient();
|
|
|
|
|
|
|
|
virtual bool Connect(wxSockAddress& addr_man, bool wait = TRUE);
|
|
|
|
|
1999-09-05 10:23:22 +00:00
|
|
|
bool WaitOnConnect(long seconds = -1, long milliseconds = 0);
|
1998-09-06 18:28:00 +00:00
|
|
|
|
1999-09-05 05:51:05 +00:00
|
|
|
virtual void OnRequest(wxSocketNotify flags);
|
1998-09-06 18:28:00 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
class WXDLLEXPORT wxSocketEvent : public wxEvent {
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxSocketEvent)
|
|
|
|
public:
|
|
|
|
wxSocketEvent(int id = 0);
|
|
|
|
|
1999-09-05 06:46:38 +00:00
|
|
|
wxSocketNotify SocketEvent() const { return m_skevt; }
|
1999-04-26 18:16:56 +00:00
|
|
|
wxSocketBase *Socket() const { return m_socket; }
|
|
|
|
|
1999-05-07 18:34:32 +00:00
|
|
|
void CopyObject(wxObject& obj_d) const;
|
|
|
|
|
1998-09-06 18:28:00 +00:00
|
|
|
public:
|
1999-09-05 06:46:38 +00:00
|
|
|
wxSocketNotify m_skevt;
|
1999-04-26 18:16:56 +00:00
|
|
|
wxSocketBase *m_socket;
|
1998-09-06 18:28:00 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef void (wxEvtHandler::*wxSocketEventFunction)(wxSocketEvent&);
|
|
|
|
|
1999-04-26 18:16:56 +00:00
|
|
|
#define EVT_SOCKET(id, func) { wxEVT_SOCKET, id, -1, \
|
1998-12-29 17:18:41 +00:00
|
|
|
(wxObjectEventFunction) (wxEventFunction) (wxSocketEventFunction) & func, \
|
|
|
|
(wxObject *) NULL },
|
1998-09-06 18:28:00 +00:00
|
|
|
|
|
|
|
#endif
|
1999-06-15 20:21:59 +00:00
|
|
|
// wxUSE_SOCKETS
|
|
|
|
|
|
|
|
#endif
|
|
|
|
// _WX_NETWORK_SOCKET_H
|