C# 클래스 GSF.ServiceProcess.ClientHelper

상속: System.ComponentModel.Component, ISupportLifecycle, ISupportInitialize, IPersistSettings
파일 보기 프로젝트 열기: GridProtectionAlliance/gsf 1 사용 예제들

Private Properties

프로퍼티 타입 설명
BeginInit void
EndInit void
RemotingClient_ConnectionAttempt void
RemotingClient_ConnectionEstablished void
RemotingClient_ConnectionException void
RemotingClient_ConnectionTerminated void
RemotingClient_ReceiveDataComplete void
UpdateStatus void

공개 메소드들

메소드 설명
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 ( ClientRequest request ) : void

Sends a request to the ServiceHelper using RemotingClient.

SendRequest ( string request ) : void

Sends a request to the ServiceHelper using RemotingClient.

TryParseActionableResponse ( ServiceResponse serviceResponse, string &sourceCommand, bool &responseSuccess ) : bool

Attempts to parse an actionable response sent from the service.

보호된 메소드들

메소드 설명
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 state ) : void

Raises the ProcessStateChanged event.

OnReceivedServiceResponse ( ServiceResponse response ) : void

Raises the ReceivedServiceResponse event.

OnReceivedServiceUpdate ( UpdateType type, string update ) : void

Raises the ReceivedServiceUpdate event.

OnServiceStateChanged ( ObjectState state ) : void

Raises the ServiceStateChanged event.

OnTelnetSessionEstablished ( ) : void

Raises the TelnetSessionEstablished event.

OnTelnetSessionTerminated ( ) : void

Raises the TelnetSessionTerminated event.

비공개 메소드들

메소드 설명
BeginInit ( ) : void
EndInit ( ) : void
RemotingClient_ConnectionAttempt ( object sender, EventArgs e ) : void
RemotingClient_ConnectionEstablished ( object sender, EventArgs e ) : void
RemotingClient_ConnectionException ( object sender, EventArgs e ) : void
RemotingClient_ConnectionTerminated ( object sender, EventArgs e ) : void
RemotingClient_ReceiveDataComplete ( object sender, int>.EventArgs e ) : void
UpdateStatus ( UpdateType type, string message ) : void

메소드 상세

ClientHelper() 공개 메소드

Initializes a new instance of the ClientHelper class.
public ClientHelper ( ) : GSF.Communication
리턴 GSF.Communication

ClientHelper() 공개 메소드

Initializes a new instance of the ClientHelper class.
public ClientHelper ( IContainer container ) : GSF.Communication
container IContainer object that contains the .
리턴 GSF.Communication

Connect() 공개 메소드

Connects RemotingClient to ServiceHelper.RemotingServer and wait until authentication is complete.
public Connect ( ) : void
리턴 void

Disconnect() 공개 메소드

Disconnects RemotingClient from ServiceHelper.RemotingServer.
public Disconnect ( ) : void
리턴 void

Dispose() 보호된 메소드

Releases the unmanaged resources used by the ClientHelper object and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
리턴 void

Initialize() 공개 메소드

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.
public Initialize ( ) : void
리턴 void

LoadSettings() 공개 메소드

Loads saved settings for the ClientHelper from the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public LoadSettings ( ) : void
리턴 void

OnAuthenticationFailure() 보호된 메소드

Raises the AuthenticationFailure event.
protected OnAuthenticationFailure ( ) : void
리턴 void

OnAuthenticationSuccess() 보호된 메소드

Raises the AuthenticationSuccess event.
protected OnAuthenticationSuccess ( ) : void
리턴 void

OnProcessStateChanged() 보호된 메소드

Raises the ProcessStateChanged event.
protected OnProcessStateChanged ( ObjectState state ) : void
state ObjectState New .
리턴 void

OnReceivedServiceResponse() 보호된 메소드

Raises the ReceivedServiceResponse event.
protected OnReceivedServiceResponse ( ServiceResponse response ) : void
response ServiceResponse received.
리턴 void

OnReceivedServiceUpdate() 보호된 메소드

Raises the ReceivedServiceUpdate event.
protected OnReceivedServiceUpdate ( UpdateType type, string update ) : void
type UpdateType One of the values.
update string Update message received.
리턴 void

OnServiceStateChanged() 보호된 메소드

Raises the ServiceStateChanged event.
protected OnServiceStateChanged ( ObjectState state ) : void
state ObjectState New .
리턴 void

OnTelnetSessionEstablished() 보호된 메소드

Raises the TelnetSessionEstablished event.
protected OnTelnetSessionEstablished ( ) : void
리턴 void

OnTelnetSessionTerminated() 보호된 메소드

Raises the TelnetSessionTerminated event.
protected OnTelnetSessionTerminated ( ) : void
리턴 void

PretendRequest() 공개 정적인 메소드

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.
public static PretendRequest ( string requestCommand ) : GSF.ServiceProcess.ClientRequestInfo
requestCommand string Command for which an object is to be created.
리턴 GSF.ServiceProcess.ClientRequestInfo

SaveSettings() 공개 메소드

Saves settings for the ClientHelper to the config file if the PersistSettings property is set to true.
has a value of null or empty string.
public SaveSettings ( ) : void
리턴 void

SendRequest() 공개 메소드

Sends a request to the ServiceHelper using RemotingClient.
public SendRequest ( ClientRequest request ) : void
request ClientRequest object to be sent.
리턴 void

SendRequest() 공개 메소드

Sends a request to the ServiceHelper using RemotingClient.
public SendRequest ( string request ) : void
request string Request text to be sent.
리턴 void

TryParseActionableResponse() 공개 정적인 메소드

Attempts to parse an actionable response sent from the service.
public static TryParseActionableResponse ( ServiceResponse serviceResponse, string &sourceCommand, bool &responseSuccess ) : bool
serviceResponse ServiceResponse to test for actionable response.
sourceCommand string Command that invoked .
responseSuccess bool Boolean success state of .
리턴 bool