TServerWinSocket Members

The following tables list the members exposed by TServerWinSocket.

	Name	Description
	AsyncInitSocket	Looks up information or forms socket connections asynchronously.
	ClientConnect	This is ClientConnect, a member of class TServerWinSocket.
	ClientDisconnect	This is ClientDisconnect, a member of class TServerWinSocket.
	ClientErrorEvent	This is ClientErrorEvent, a member of class TServerWinSocket.
	ClientRead	This is ClientRead, a member of class TServerWinSocket.
	ClientWrite	This is ClientWrite, a member of class TServerWinSocket.
	DoCreateThread	This is DoCreateThread, a member of class TServerWinSocket.
	DoListen	Opens a listening connection.
	DoOpen	Opens a connection to a remote socket.
	Error	Generates an OnErrorEvent event.
	Event	Triggers an OnSocketEvent event.
	GetClientSocket	This is GetClientSocket, a member of class TServerWinSocket.
	GetServerThread	This is GetServerThread, a member of class TServerWinSocket.
	InitSocket	Generates a windows Internet socket address structure from a description of the desired socket port.
	Listen	Opens a listening connection for a server socket.
	SetAsyncStyles	Sets the ASyncStyles property.
	SetServerType	This is SetServerType, a member of class TServerWinSocket.
	SetThreadCacheSize	This is SetThreadCacheSize, a member of class TServerWinSocket.
	ThreadEnd	This is ThreadEnd, a member of class TServerWinSocket.
	ThreadStart	This is ThreadStart, a member of class TServerWinSocket.

Public Events

	Name	Description
	OnClientConnect	Occurs when a client socket completes a connection accepted by the listening socket.
	OnClientDisconnect	Occurs when one of the connections to a client socket is closed.
	OnClientError	Occurs when a failure is encountered when establishing, using, or terminating the socket connection to an individual client socket.
	OnClientRead	Occurs when the server socket should read information from a client socket.
	OnClientWrite	Occurs when the server socket should write information to a client socket.
	OnErrorEvent	Occurs when the socket fails in making, using, or shutting down a connection.
	OnGetSocket	Occurs when the server socket needs to create a new TServerClientWinSocket object to form the connection to a client socket.
	OnGetThread	Occurs when the server socket needs to create a new execution thread for a connection to a client socket.
	OnSocketEvent	Occurs when the Windows socket receives notification of asynchronous events.
	OnThreadEnd	Occurs when a client socket connection is terminated and the associated thread finishes execution.
	OnThreadStart	Occurs when the execution thread for a connection to a client socket starts up.

Public Methods

	Name	Description
	Accept	Accepts a connection to a client socket.
	Close	Shuts down the socket connection if it is open.
	Connect	Provides the interface for a method that responds to connection notifications from client sockets.
	Create	Creates an instance of TServerWinSocket from a Windows socket handle.
	DefaultHandler	Processes message records.
	Destroy	Destroys an instance of TServerWinSocket.
	Disconnect	Shuts down the socket connection represented by a Windows socket handle.
	GetClientThread	Returns the execution thread used by the client connection managed by the ClientSocket parameter.
	Lock	Starts a critical section, blocking all other execution threads until the Unlock method is called.
	LookupName	Generates the portion of a Windows Internet socket address structure that describes the host.
	LookupService	Returns the port number associated with a specific service.
	Open	Opens a connection to a remote socket.
	Read	Generates an OnSocketEvent of type seRead in response to notifications that the socket connection is ready.
	ReceiveBuf	Reads up to Count bytes from the socket connection into the Buf parameter.
	ReceiveLength	Returns the number of bytes ready to be sent over the socket connection.
	ReceiveText	Reads a string from the socket connection.
	SendBuf	Writes Count bytes to the socket connection from the Buf parameter.
	SendStream	Writes all the information that can be read from the AStream parameter to the socket connection.
	SendStreamThenDrop	Writes all the information that can be read from the AStream parameter to the socket connection and then terminates the connection.
	SendText	Writes the string S to the socket connection.
	Unlock	Reenables execution in other threads after a critical section begun by the Lock method.
	Write	Generates an OnSocketEvent of type seWrite in response to notifications that the socket connection is ready.

Public Properties

	Name	Description
	ActiveConnections	Indicates the number of connections to client sockets accepted by this listening socket that are currently open.
	ActiveThreads	Indicates the number of TServerClientThread objects currently in use by the socket connections listed in the Connections array.
	Addr	Specifies the Internet socket address structure used in Windows socket API calls to represent the full specification of the socket port.
	ASyncStyles	Determines which asynchronous events the socket can receive.
	Connected	Indicates whether the socket connection is open and available for communication with other machines.
	Connections	Lists all TServerClientWinSocket objects that represent open socket connections to client sockets that were accepted by this listening socket.
	Data	Points to application-specific data associated with the socket.
	Handle	Specifies the handle of the window that receives notifications from the Windows socket.
	IdleThreads	Indicates the number of unused TServerClientThread objects available in the cache.
	LocalAddress	Specifies the IP address of the local system that was bound to the socket connection.
	LocalHost	Specifies the name of the local system.
	LocalPort	Specifies the ID number of the port used by the socket connection.
	LookupState	Indicates any asynchronous activities occurring while opening a connection.
	RemoteAddr	Specifies the Internet socket address structure used in Windows socket API calls to represent the full specification of the remote socket port.
	RemoteAddress	Specifies the IP address of the remote system that was bound to the socket connection.
	RemoteHost	Specifies the name of the remote system.
	RemotePort	Specifies the ID number of the port used by the RemoteHost to form the socket connection.
	ServerType	Specifies whether each connection accepted by the server socket is non-blocking, or if it is automatically given a separate execution thread.
	SocketHandle	Specifies the Windows handle for the socket.
	ThreadCacheSize	Indicates the number of TServerClientThread objects cached for reuse by new connections to client sockets.

What do you think about this topic? Send feedback!