Contents Up Previous Next

wxSocketHandler

Derived from

wxObject

Include files

<wx/socket.h>

Members

wxSocketHandler::wxSocketHandler
wxSocketHandler::~wxSocketHandler
wxSocketHandler::Register
wxSocketHandler::UnRegister
wxSocketHandler::Count
wxSocketHandler::CreateServer
wxSocketHandler::CreateClient
wxSocketHandler::Master
wxSocketHandler::Wait
wxSocketHandler::YieldSock


wxSocketHandler::wxSocketHandler

wxSocketHandler()

Constructs a new wxSocketHandler.

It is advised to use wxSocketHandler::Master to get a socket handler. But creating a socket handler is useful to group many sockets.


wxSocketHandler::~wxSocketHandler

~wxSocketHandler()

Destroys a wxSocketHandler object.


wxSocketHandler::Register

void Register(wxSocketBase *socket)

Register a socket: if it is already registered in this handler it will just return immediately.

Parameters

socket


wxSocketHandler::UnRegister

void UnRegister(wxSocketBase *socket)

UnRegister a socket: if it isn't registered in this handler it will just return.

Parameters

socket


wxSocketHandler::Count

unsigned long Count() const

Returns the number of sockets registered in the handler.

Return value

Number of sockets registered.


wxSocketHandler::CreateServer

wxSocketServer * CreateServer(wxSockAddress& address, wxSocketBase::wxSockFlags flags = wxSocketbase::NONE)

Creates a new wxSocketServer object. The object is automatically registered to the current socket handler. For a detailed description of the parameters, see wxSocketServer::wxSocketServer.

Return value

Returns a new socket server.


wxSocketHandler::CreateClient

wxSocketServer * CreateClient(wxSocketBase::wxSockFlags flags = wxSocketbase::NONE)

Creates a new wxSocketClient object. The object is automatically registered to the current socket handler.

For a detailed description of the parameters, see wxSocketClient::Connect.

Return value

Returns a new socket client.


wxSocketHandler::Master

static wxSocketHandler& Master()

Returns a default socket handler.


wxSocketHandler::Wait

int Wait(long seconds,long microseconds)

Wait for an event on all registered sockets.

Parameters

seconds

microsecond

Return value

Returns 0 if a timeout occured, else the number of events detected.

See also

wxSocketBase::Wait


wxSocketHandler::YieldSock

void YieldSock()

Execute pending requests in all registered sockets.