Click or drag to resize

wclServerConnection Class

The base class for all server connections.
Inheritance Hierarchy
SystemObject
  wclCommunicationwclCustomConnection
    wclCommunicationwclServerConnection
      wclCommunicationwclServerDataConnection

Namespace: wclCommunication
Assembly: wclCommunication (in wclCommunication.dll) Version: 7.8.3.0 (7.8.3.0)
Syntax
Copy
public abstract class wclServerConnection : wclCustomConnection

The wclServerConnection type exposes the following members.

Constructors
 NameDescription
Public methodwclServerConnection Creates a new server connection.
Top
Properties
 NameDescription
Public propertyClientsCount Gets the number of connected clients.
Public propertyItem Gets a connected client by its index.
Public propertyReceiver Gets the connection message receiver object.
(Inherited from wclCustomConnection)
Public propertyState Gets the connection state.
Public propertyThreadId Gets the connection's thread ID.
(Inherited from wclCustomConnection)
Top
Methods
 NameDescription
Public methodClose The method disconnects all connected clients and closes the server.
Protected methodCreateNewClientConnection Sends a notification to the main thread to create and init new client connection.
Protected methodDoClosed Fires the OnClosed event.
Protected methodDoConnect Fires the OnConnect event.
Protected methodDoDisconnect Fires the OnDisconnect event.
Protected methodDoListen Fires the OnListen event.
Protected methodEnter Enters the connection's critical section.
(Inherited from wclCustomConnection)
Public methodEqualsDetermines whether the specified Object is equal to the current Object.
(Inherited from Object)
Protected methodFinalize Frees the server connection.
(Overrides ObjectFinalize)
Public methodGetHashCodeServes as a hash function for a particular type.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodHalClose Implements a hardware-dependent method to stop listening.
Protected methodHalCreateClient The method creates a hardware and transport-dependent client connection.
Protected methodHalListen Implements a hardware-dependent method for listening the client connections.
Protected methodHalPrepare Implements a hardware-dependent code that prepares for listening.
Protected methodInternalClose Closes the server.
Protected methodLeave Exists *leaves) the connection's critical section.
(Inherited from wclCustomConnection)
Public methodListen The method starts listening for client connections.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMessageReceived The message receiver calls this method when a new notification message has been received.
(Overrides wclCustomConnectionMessageReceived(wclMessage))
Protected methodSetClientEvents The method sets the client's event handlers.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventOnClosed The event fires when the server is closed.
Public eventOnConnect The event fires when a remote client is connected to the server.
Public eventOnDisconnect The event fires when a remote client has disconnected from the server.
Public eventOnListen The event fires when the server is ready to accept incoming connections (is in listening state).
Top
Remarks
An application must never create this class directly. Instead of that an application must use high-level components.
See Also