Difference between revisions of "Midware TAppSrvClient"

From Overbyte
Jump to navigation Jump to search
 
(15 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
{|  
 
{|  
 
| width="140" valign="top" | [[Midware_TAppSrvClient.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_TAppSrvClient.Handle | Handle]] |||| The handle for the hidden window used to send and receive internal messages for component work.
 
|-
 
|-
 
| valign="top" | [[Midware_TAppSrvClient.AnswerStatus | AnswerStatus]] |||| The AnswerStatus property hold the ResultStatus returned back by the application server.
 
| valign="top" | [[Midware_TAppSrvClient.AnswerStatus | AnswerStatus]] |||| The AnswerStatus property hold the ResultStatus returned back by the application server.
Line 41: Line 43:
 
| valign="top" | [[Midware_TAppSrvClient.SocksUsercode | SocksUsercode]] |||| Socks5 usercode.
 
| valign="top" | [[Midware_TAppSrvClient.SocksUsercode | SocksUsercode]] |||| Socks5 usercode.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.State | Stade]] |||| State property gives the component state:
+
| 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 TWSocket component used for communication with the application server.
 
 
|-
 
|-
 +
| valign="top" | [[Midware_TAppSrvClient.WSocket | WSocket]] |||| WSocket is the reference to the underlaiying [[Midware_TClientWSocket | TClientWSocket]] component used for communication with the application server.
 
|}
 
|}
  
Line 58: Line 59:
  
 
{|
 
{|
−
| width="140" valign="top" | [[Midware_TAppSrvClient.OnAfterProcessReply | OnAfterProcessReply]] |||| Use to cleanup allocated resources in the OnBeforeProcessReply event handler.
+
| width="140" valign="top" | [[Midware_TAppSrvClient.OnAfterProcessReply | OnAfterProcessReply]] |||| Occurs after a reply has been processed.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnAfterSendRequest | OnAfterSendRequest]] |||| The OnAfterSendReply event is called once the reply header and body has ben written to the internal buffer for sending in the background.
+
| valign="top" | [[Midware_TAppSrvClient.OnAfterSendRequest | OnAfterSendRequest]] |||| Occurs just after a request has been sent to server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnBeforeProcessReply | OnBeforeProcessReply]] |||| The event OnBeforeProcessReply is triggered when a reply have been received from the server, just before it is processed for header and body extraction.  
+
| valign="top" | [[Midware_TAppSrvClient.OnBeforeProcessReply | OnBeforeProcessReply]] |||| Occurs when a reply has been received and before it is processed.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnBannerRcdv | OnBannerRcdv]] |||| The event handler could be used to verify the received banner to be sure we are connected to the right server, or to display it for the user, or to log it to a log file.
+
| valign="top" | [[Midware_TAppSrvClient.OnBannerRcdv | OnBannerRcdv]] |||| Occurs when banner is received from server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnBeforeSendRequest | OnBeforeSendRequest]] ||||  
+
| valign="top" | [[Midware_TAppSrvClient.OnBeforeSendRequest | OnBeforeSendRequest]] |||| Occurs before a request is ready to be sent to server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnRequestDone | OnRequestDone]] |||| When the application server sent the answer to the client, the OnRequestdone event is triggered.  
+
| valign="top" | [[Midware_TAppSrvClient.OnRequestDone | OnRequestDone]] |||| Occurs when a request has been statisfied and result set is available.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnSessionClosed | OnSessionClosed]] |||| The event OnSessionConnected is triggered when the connection has been closed.  
+
| valign="top" | [[Midware_TAppSrvClient.OnSessionClosed | OnSessionClosed]] |||| Occurs when connection with application server has been closed.  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnSessionConnected | OnSessionConnected]] |||| The event OnSessionConnected is triggered when the connection has been established with the application server.
+
| valign="top" | [[Midware_TAppSrvClient.OnSessionConnected | OnSessionConnected]] |||| Occurs when connection is established with application server.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnSocksAuthState | OnSocksAuthState]] |||| OnSocksAuthState event is triggered for each state in socks authentication process.  
+
| valign="top" | [[Midware_TAppSrvClient.OnSocksAuthState | OnSocksAuthState]] |||| Occurs during socks authentication process.
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnSocksConnected | OnSocksConnected]] |||| The event OnSocksConnected is triggered when the connection has been established with the socks server.  
+
| valign="top" | [[Midware_TAppSrvClient.OnSocksConnected | OnSocksConnected]] |||| Occurs when connected to socks server (firewall).  
 
|-
 
|-
−
| valign="top" | [[Midware_TAppSrvClient.OnSocksError | OnSocksError]] |||| OnSocksError event is triggered when an error related to socks connection has been detected.
+
| valign="top" | [[Midware_TAppSrvClient.OnSocksError | OnSocksError]] |||| Occurs when a socks error has been detected.
 
|}
 
|}
  

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"