Property | Type | Description | |
---|---|---|---|
BeginInit | void | ||
EndInit | void | ||
RemotingClient_ConnectionAttempt | void | ||
RemotingClient_ConnectionEstablished | void | ||
RemotingClient_ConnectionException | void | ||
RemotingClient_ConnectionTerminated | void | ||
RemotingClient_ReceiveDataComplete | void | ||
UpdateStatus | void |
Method | Description | |
---|---|---|
ClientHelper ( ) : GSF.Communication |
Initializes a new instance of the ClientHelper class.
|
|
ClientHelper ( IContainer container ) : GSF.Communication |
Initializes a new instance of the ClientHelper class.
|
|
Connect ( ) : void |
Connects RemotingClient to ServiceHelper.RemotingServer and wait until authentication is complete.
|
|
Disconnect ( ) : void |
Disconnects RemotingClient from ServiceHelper.RemotingServer.
|
|
Initialize ( ) : void |
Initializes the ClientHelper. Initialize() is to be called by user-code directly only if the ClientHelper is not consumed through the designer surface of the IDE. |
|
LoadSettings ( ) : void |
Loads saved settings for the ClientHelper from the config file if the PersistSettings property is set to true.
|
|
PretendRequest ( string requestCommand ) : GSF.ServiceProcess.ClientRequestInfo |
Returns an ClientRequestInfo object for the specified requestCommand that can be used to invoke ServiceHelper.ClientRequestHandlers manually as if the request was sent by a ClientHelper remotely.
|
|
SaveSettings ( ) : void |
Saves settings for the ClientHelper to the config file if the PersistSettings property is set to true.
|
|
SendRequest ( |
Sends a request to the ServiceHelper using RemotingClient.
|
|
SendRequest ( string request ) : void |
Sends a request to the ServiceHelper using RemotingClient.
|
|
TryParseActionableResponse ( |
Attempts to parse an actionable response sent from the service.
|
Method | Description | |
---|---|---|
Dispose ( bool disposing ) : void |
Releases the unmanaged resources used by the ClientHelper object and optionally releases the managed resources.
|
|
OnAuthenticationFailure ( ) : void |
Raises the AuthenticationFailure event.
|
|
OnAuthenticationSuccess ( ) : void |
Raises the AuthenticationSuccess event.
|
|
OnProcessStateChanged ( ObjectState |
Raises the ProcessStateChanged event.
|
|
OnReceivedServiceResponse ( |
Raises the ReceivedServiceResponse event.
|
|
OnReceivedServiceUpdate ( UpdateType type, string update ) : void |
Raises the ReceivedServiceUpdate event.
|
|
OnServiceStateChanged ( ObjectState |
Raises the ServiceStateChanged event.
|
|
OnTelnetSessionEstablished ( ) : void |
Raises the TelnetSessionEstablished event.
|
|
OnTelnetSessionTerminated ( ) : void |
Raises the TelnetSessionTerminated event.
|
Method | Description | |
---|---|---|
BeginInit ( ) : void | ||
EndInit ( ) : void | ||
RemotingClient_ConnectionAttempt ( object sender, |
||
RemotingClient_ConnectionEstablished ( object sender, |
||
RemotingClient_ConnectionException ( object sender, EventArgs |
||
RemotingClient_ConnectionTerminated ( object sender, |
||
RemotingClient_ReceiveDataComplete ( object sender, int>.EventArgs |
||
UpdateStatus ( UpdateType type, string message ) : void |
public ClientHelper ( IContainer container ) : GSF.Communication | ||
container | IContainer | |
return | GSF.Communication |
protected Dispose ( bool disposing ) : void | ||
disposing | bool | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
return | void |
protected OnProcessStateChanged ( ObjectState |
||
state | ObjectState |
New |
return | void |
protected OnReceivedServiceResponse ( |
||
response | ||
return | void |
protected OnReceivedServiceUpdate ( UpdateType type, string update ) : void | ||
type | UpdateType | One of the |
update | string | Update message received. |
return | void |
protected OnServiceStateChanged ( ObjectState |
||
state | ObjectState |
New |
return | void |
protected OnTelnetSessionEstablished ( ) : void | ||
return | void |
protected OnTelnetSessionTerminated ( ) : void | ||
return | void |
public static PretendRequest ( string requestCommand ) : GSF.ServiceProcess.ClientRequestInfo | ||
requestCommand | string | Command for which an |
return | GSF.ServiceProcess.ClientRequestInfo |
public SendRequest ( |
||
request | ||
return | void |
public SendRequest ( string request ) : void | ||
request | string | Request text to be sent. |
return | void |
public static TryParseActionableResponse ( |
||
serviceResponse | ||
sourceCommand | string | Command that invoked |
responseSuccess | bool | Boolean success state of |
return | bool |