Difference between revisions of "Midware TAppSrvClient"

From Overbyte
Jump to navigation Jump to search
 
(20 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
== Properties ==
 
== Properties ==
 
{|  
 
{|  
−
| width="140" valign="top" | [[Midware_TAppServer.Answer | Answer]] |||| The Answer property holds the answer from the application server.
+
| width="140" valign="top" | [[Midware_TAppSrvClient.Answer | Answer]] |||| The Answer property holds the answer from the application server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.AnswerStatus | AnswerStatus]] |||| The AnswerStatus property hold the ResultStatus returned back by the application server.
+
| valign="top" | [[Midware_TAppSrvClient.Handle | Handle]] |||| The handle for the hidden window used to send and receive internal messages for component work.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.Connected | Connected]] |||| The connected property tell if connection with the server is alive.
+
| valign="top" | [[Midware_TAppSrvClient.AnswerStatus | AnswerStatus]] |||| The AnswerStatus property hold the ResultStatus returned back by the application server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.FunctionCode | FunctionCode]] |||| The function code is a string which is used by the application server to know which server object to instanciate to execute the request.
+
| valign="top" | [[Midware_TAppSrvClient.Connected | Connected]] |||| The connected property tell if connection with the server is alive.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.Port | Port]] |||| This is the port number used by the server to listen for clients.
+
| valign="top" | [[Midware_TAppSrvClient.FunctionCode | FunctionCode]] |||| The function code is a string which is used by the application server to know which server object to instanciate to execute the request.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.Request | Request]] |||| The request property holds the parameters sent to the application server.  
+
| valign="top" | [[Midware_TAppSrvClient.Port | Port]] |||| This is the port number used by the server to listen for clients.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.RequestBody | RequestBody]] |||| RequestBody gives the address where the message body is stored just before sending it to the application server.  
+
| valign="top" | [[Midware_TAppSrvClient.Request | Request]] |||| The request property holds the parameters sent to the application server.  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.RequestBodyLen | RequestBodyLen]] |||| RequestBodyLen gives the message body length just before sending it to the application server.
+
| valign="top" | [[Midware_TAppSrvClient.RequestBody | RequestBody]] |||| RequestBody gives the address where the message body is stored just before sending it to the application server.  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.RequestHeader | RequestHeader]] |||| RequestHeader gives the address where the message header is stored just before sending it to the application server.
+
| valign="top" | [[Midware_TAppSrvClient.RequestBodyLen | RequestBodyLen]] |||| RequestBodyLen gives the message body length just before sending it to the application server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.RequestHeaderLen | RequestHeaderLen]] |||| RequestHeaderLen gives the message header length just before sending it to the application server.
+
| valign="top" | [[Midware_TAppSrvClient.RequestHeader | RequestHeader]] |||| RequestHeader gives the address where the message header is stored just before sending it to the application server.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.RequestHeaderLen | RequestHeaderLen]] |||| RequestHeaderLen gives the message header length just before sending it to the application server.
 
|-
 
|-
 
| valign="top" | [[Midware_TAppServer.Server | Server]] |||| This is the IP address or hostname for the application server.  
 
| valign="top" | [[Midware_TAppServer.Server | Server]] |||| This is the IP address or hostname for the application server.  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.SocksAuthentication | SocksAuthentication]] |||| SocksAuthentication specifies which socks5 authentication method to use.
+
| valign="top" | [[Midware_TAppSrvClient.SocksAuthentication | SocksAuthentication]] |||| SocksAuthentication specifies which socks5 authentication method to use.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.SocksPassword | SocksPassword]] |||| SocksPassword is the password used for Socks5 connection.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.SocksPort| SocksPort]] |||| Socks5 port number.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.SocksServer | SocksServer]] |||| IP or hostname for socks5 server.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.SocksUsercode | SocksUsercode]] |||| Socks5 usercode.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.State | State]] |||| State property gives the component state:
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.WSocket | WSocket]] |||| WSocket is the reference to the underlaiying [[Midware_TClientWSocket | TClientWSocket]] component used for communication with the application server.
 +
|}
 +
 
 +
== Methods ==
 +
 
 +
{|
 +
| width="140" valign="top" | [[Midware_TAppSrvClient.Close | Close]] |||| Close the communication with the application server.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.Send | Send]] |||| Send a FunctionCode  and Request (parmeters) to the application server.
 +
|-
 +
|}
 +
== Events ==
 +
 
 +
{|
 +
| width="140" valign="top" | [[Midware_TAppSrvClient.OnAfterProcessReply | OnAfterProcessReply]] |||| Occurs after a reply has been processed.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.OnAfterSendRequest | OnAfterSendRequest]] |||| Occurs just after a request has been sent to server.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.OnBeforeProcessReply | OnBeforeProcessReply]] |||| Occurs when a reply has been received and before it is processed.
 +
|-
 +
| valign="top" | [[Midware_TAppSrvClient.OnBannerRcdv | OnBannerRcdv]] |||| Occurs when banner is received from server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.SocksPassword | SocksPassword]] |||| SocksPassword is the password used for Socks5 connection.
+
| valign="top" | [[Midware_TAppSrvClient.OnBeforeSendRequest | OnBeforeSendRequest]] |||| Occurs before a request is ready to be sent to server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.SocksPort| SocksPort]] |||| Socks5 port number.
+
| valign="top" | [[Midware_TAppSrvClient.OnRequestDone | OnRequestDone]] |||| Occurs when a request has been statisfied and result set is available.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.SocksServer | SocksServer]] |||| IP or hostname for socks5 server.
+
| valign="top" | [[Midware_TAppSrvClient.OnSessionClosed | OnSessionClosed]] |||| Occurs when connection with application server has been closed.  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.SocksUsercode | SocksUsercode]] |||| Socks5 usercode.
+
| valign="top" | [[Midware_TAppSrvClient.OnSessionConnected | OnSessionConnected]] |||| Occurs when connection is established with application server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.State | Stade]] |||| State property gives the component state:
+
| valign="top" | [[Midware_TAppSrvClient.OnSocksAuthState | OnSocksAuthState]] |||| Occurs during socks authentication process.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppServer.WSocket | WSocket]] |||| WSocket is the reference to the underlaiying TWSocket component used for communication with the application server.
+
| valign="top" | [[Midware_TAppSrvClient.OnSocksConnected | OnSocksConnected]] |||| Occurs when connected to socks server (firewall).  
 
|-
 
|-
 +
| valign="top" | [[Midware_TAppSrvClient.OnSocksError | OnSocksError]] |||| Occurs when a socks error has been detected.
 +
|}
 +
 +
== How to ==
 +
 +
{{Midware_Components_Footer}}

Latest revision as of 15:15, 24 May 2011

Main page -> Midware component reference -> TAppSrvClient

Overview

unit ApsCli.pas

TAppSrvClient is used on the client side to connect to the application server. His main purpose is to send a request to the application server and receive answers from the application server. TAppSrvClient establish and manage connection and dialog with MidWare application server.

Properties

Answer The Answer property holds the answer from the application server.
Handle The handle for the hidden window used to send and receive internal messages for component work.
AnswerStatus The AnswerStatus property hold the ResultStatus returned back by the application server.
Connected The connected property tell if connection with the server is alive.
FunctionCode The function code is a string which is used by the application server to know which server object to instanciate to execute the request.
Port This is the port number used by the server to listen for clients.
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.
State State property gives the component state:
WSocket WSocket is the reference to the underlaiying TClientWSocket component used for communication with the application server.

Methods

Close Close the communication with the application server.
Send Send a FunctionCode and Request (parmeters) to the application server.

Events

OnAfterProcessReply Occurs after a reply has been processed.
OnAfterSendRequest Occurs just after a request has been sent to server.
OnBeforeProcessReply Occurs when a reply has been received and before it is processed.
OnBannerRcdv Occurs when banner is received from server.
OnBeforeSendRequest Occurs before a request is ready to be sent to server.
OnRequestDone Occurs when a request has been statisfied and result set is available.
OnSessionClosed Occurs when connection with application server has been closed.
OnSessionConnected Occurs when connection is established with application server.
OnSocksAuthState Occurs during socks authentication process.
OnSocksConnected Occurs when connected to socks server (firewall).
OnSocksError Occurs when a socks error has been detected.

How to

Midware Components Reference

Retrieved from "http://wiki.overbyte.eu/wiki/index.php?title=Midware_TAppSrvClient&oldid=3095"