wxSocketServer Class Reference
[Networking]

#include <wx/socket.h>

Inheritance diagram for wxSocketServer:

List of all members.

---

Detailed Description

Library:  wxNet

Category:  Networking

Public Member Functions
	wxSocketServer (const wxSockAddress &address, wxSocketFlags flags=wxSOCKET_NONE)
	~wxSocketServer ()
wxSocketBase *	Accept (bool wait=true)
bool	AcceptWith (wxSocketBase &socket, bool wait=true)
bool	WaitForAccept (long seconds=-1, long millisecond=0)

---

Constructor & Destructor Documentation

wxSocketServer::wxSocketServer	(	const wxSockAddress &	address,
		wxSocketFlags	flags = wxSOCKET_NONE
	)

Constructs a new server and tries to bind to the specified address.

Before trying to accept new connections, remember to test whether it succeeded with wxSocketBase:IsOk().

Parameters:

	address	Specifies the local address for the server (e.g. port number).
	flags	Socket flags (See wxSocketBase::SetFlags())

wxSocketServer::~wxSocketServer

(

)

Destructor (it doesn't close the accepted connections).

---

Member Function Documentation

wxSocketBase* wxSocketServer::Accept

(

bool

wait = true

)

Accepts an incoming connection request, and creates a new wxSocketBase object which represents the server-side of the connection.

If wait is true and there are no pending connections to be accepted, it will wait for the next incoming connection to arrive. Warning: This will block the GUI.

If wait is false, it will try to accept a pending connection if there is one, but it will always return immediately without blocking the GUI. If you want to use Accept() in this way, you can either check for incoming connections with WaitForAccept() or catch wxSOCKET_CONNECTION events, then call Accept() once you know that there is an incoming connection waiting to be accepted.

Returns:

Returns an opened socket connection, or NULL if an error occurred or if the wait parameter was false and there were no pending connections.

See also:

WaitForAccept(), wxSocketBase::SetNotify(), wxSocketBase::Notify(), AcceptWith()

bool wxSocketServer::AcceptWith	(	wxSocketBase &	socket,
		bool	wait = true
	)

Accept an incoming connection using the specified socket object.

Parameters:

socket

Socket to be initialized

Returns:

Returns true on success, or false if an error occurred or if the wait parameter was false and there were no pending connections.

See also:

WaitForAccept(), wxSocketBase::SetNotify(), wxSocketBase::Notify(), Accept()

bool wxSocketServer::WaitForAccept	(	long	seconds = -1,
		long	millisecond = 0
	)

This function waits for an incoming connection. Use it if you want to call Accept() or AcceptWith() with wait set to false, to detect when an incoming connection is waiting to be accepted.

Parameters:

	seconds	Number of seconds to wait. If -1, it will wait for the default timeout, as set with wxSocketBase::SetTimeout().
	millisecond	Number of milliseconds to wait.

Returns:

true if an incoming connection arrived, false if the timeout elapsed.

See also:

Accept(), AcceptWith(), wxSocketBase::InterruptWait()