Midware TClientWSocket

Main page -> Midware component reference -> TClientWSocket

Overview

unit

ApSrvCli.pas

TClientWSocket is a specialized TWSocket used to handle client connection with application server. A new TClientWSocket is instanciated by TAppServer when a client connect to the server. TClientWSocket is destroyed after client disconnect.

Do not confuse TClientWSocket with TAppSrvClient which is the client application side. TClientWSocket is used on the server side to handle client connections, TAppSrvClient is used on the client side to connect to the application server. Both components are talking to each other.

User code in an ordinary application server never create a TClientWSocket instance. Instead, it uses instances created by TAppServer and accessed thru his ClientWSocket indexed property or thru reference passed by events such as OnClientCommand.

Properties

Banner		The banner to be sent to the client upon connection. Must be a single line.
Busy		Busy is TRUE while a the previous request is still executing.
CommandCount		Number of commands issued by the client. Useful for statistics or accounting purposes.
CommandTimeout		Timeout value.
ConnectedSinze		Gives the time when the client connected.
HSocket		HSocket is the underlaying winsock DLL handle for the connection handled by TClientWSocket component.
Request		The request property holds the parameters sent to the application server.
RequestBody		RequestBody gives the address where the message body is stored just before sending it to the application server.
RequestBodyLen		RequestBodyLen gives the message body length just before sending it to the application server.
RequestHeader		RequestHeader gives the address where the message header is stored just before sending it to the application server.
RequestHeaderLen		RequestHeaderLen gives the message header length just before sending it to the application server.
Server		This is the IP address or hostname for the application server.
SocksAuthentication		SocksAuthentication specifies which socks5 authentication method to use.
SocksPassword		SocksPassword is the password used for Socks5 connection.
SocksPort		Socks5 port number.
SocksServer		IP or hostname for socks5 server.
SocksUsercode		Socks5 usercode.
Stade		State property gives the component state:
WSocket		WSocket is the reference to the underlaiying TWSocket component used for communication with the application server.