TWSocketServer

Main page -> ICS component reference -> TWSocketServer

Overview

unit		WSocketS.pas
inheritance		TWSocket

TWSocketServer will normally be used to listen on a given tcp port. When a client connect, it will instanciate a new TWSocketClient component to handle communication with client. Normally you will derive your own component from TWSocketClient to add private data and methods to handle your processing needs. You tell TWSocketServer which component class it has to instanciate using ClientClass property. You have to initialize each instances created to handle each client from OnClientConnect event handler. TWSocketServer maintain a list of connected clients. You can access it using Client[] indexed property. ClientCount property is the size of Client[] array.

Since it is derived from TWSocket, lots of properties and events are unused and not listed here. Properties and events that have a meaning in both server or client component are listed here.

Note that TWSocketServer is only usable for incoming TCP connections. Use TWSocket if you need use UDP.

Properties

Addr		The interface to listen on.
Banner		A short message line sent when client connect.
BannerTooBusy		A short message sent when client connect and number of client already exceed MaxClients limit.
Client		Indexed property giving access to all connected clients.
ClientClass		Class the component use to handle each incomming connection.
ClientCount		Number of connected clients.
Handle		Handle of the hidden window used for socket operation.
HSocket		Underlaying winsock socket handle.
LastError		Last error occured.
ListenBacklog		How many pending connection the system has to accept before denying access.
MaxClients		Max number of connected client. All subsequent connections will be closed.
Port		TCP port or service name to listen to.
PortNum		Readonly property with numeric value corresponding to Port.
Proto		Protocol used. Must be 'tcp'.
State		Gives the satet of the component.

Methods

Abort		Align test
Close
CloseDelayed
Create
Destroy
IsClient
Listen
MessageLoop
MessagePump
ProcessMessage
ProcessMessages
Release
ThreadAttach
ThreadDetach		Align test

Events

OnBgException		Align test
OnChangeState
OnClientConnect
OnClientCreate
OnClientDisconnect
OnError
OnMessagePump

How to

• Stop accepting connections

---

ICS Components Reference