wclServerConnection Class

The base class for all server connections.

Inheritance Hierarchy

Namespace: wclCommunication
Assembly: wclCommunication (in wclCommunication.dll) Version: 7.9.6.0 (7.9.6.0)

Syntax

public abstract class wclServerConnection : wclCustomConnection

Public MustInherit Class wclServerConnection
	Inherits wclCustomConnection

public ref class wclServerConnection abstract : public wclCustomConnection

The wclServerConnection type exposes the following members.

Constructors

	Name	Description
	wclServerConnection	Creates a new server connection.

Properties

	Name	Description
	ClientsCount	Gets the number of connected clients.
	CS	Gets the connection critical section. (Inherited from wclCustomConnection)
	Item	Gets a connected client by its index.
	MessageProcessing	Gets the message processing method used by the connection. (Inherited from wclCustomConnection)
	Receiver	Gets the connection message receiver object. (Inherited from wclCustomConnection)
	State	Gets the connection state.
	ThreadId	Gets the connection's thread ID. (Inherited from wclCustomConnection)

Methods

	Name	Description
	Close	The method disconnects all connected clients and closes the server.
	CreateNewClientConnection	Sends a notification to the main thread to create and init new client connection.
	DoClosed	Fires the OnClosed event.
	DoConnect	Fires the OnConnect event.
	DoDisconnect	Fires the OnDisconnect event.
	DoListen	Fires the OnListen event.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object)
	Finalize	Frees the server connection. (Overrides ObjectFinalize)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HalClose	Implements a hardware-dependent method to stop listening.
	HalCreateClient	The method creates a hardware and transport-dependent client connection.
	HalListen	Implements a hardware-dependent method for listening the client connections.
	HalPrepare	Implements a hardware-dependent code that prepares for listening.
	InternalClose	Closes the server.
	Listen	The method starts listening for client connections.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MessageReceived	The message receiver calls this method when a new notification message has been received. (Overrides wclCustomConnectionMessageReceived(wclMessage))
	SetClientEvents	The method sets the client's event handlers.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	OnClosed	The event fires when the server is closed.
	OnConnect	The event fires when a remote client is connected to the server.
	OnDisconnect	The event fires when a remote client has disconnected from the server.
	OnListen	The event fires when the server is ready to accept incoming connections (is in listening state).

Remarks

An application must never create this class directly. Instead of that an application must use high-level components.