C# Class GSF.TimeSeries.ServiceClientBase

Represents a client that can remotely access the time-series framework service host.
Inheritance: IDisposable
Mostrar archivo Open project: GridProtectionAlliance/gsf

Public Methods

Method Description
Dispose ( ) : void

Releases all the resources used by the ServiceClientBase object.

Initialize ( ) : void

Initializes the remoting client, client helper, and error logger.

ServiceClientBase ( ) : System

Creates a new instance of the ServiceClientBase class.

Start ( string args ) : void

Handles service start event.

Protected Methods

Method Description
ClientHelper_ReceivedServiceResponse ( object sender, EventArgs e ) : void

Client helper service response reception handler.

ClientHelper_ReceivedServiceUpdate ( object sender, string>.EventArgs e ) : void

Client helper service update reception handler.

ClientHelper_TelnetSessionEstablished ( object sender, EventArgs e ) : void

Client helper telnet session established handler.

ClientHelper_TelnetSessionTerminated ( object sender, EventArgs e ) : void

Client helper telnet session terminated handler.

Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the ServiceClientBase object and optionally releases the managed resources.

Private Methods

Method Description
ClientHelper_AuthenticationFailure ( object sender, CancelEventArgs e ) : void

Client helper authentication failure reception handler.

ClientHelper_AuthenticationSuccess ( object sender, EventArgs e ) : void

Client helper authentication success reception handler.

Connect ( ) : void
Connect ( string username, string password ) : void
DisplayHelp ( ) : void
InitializeTcpClient ( ) : TcpClient
InitializeTlsClient ( ) : TlsClient
PromptForCredentials ( StringBuilder username, StringBuilder password ) : void
RemoteCertificateValidationCallback ( object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors ) : bool
SetNetworkCredential ( NetworkCredential credential ) : void
Write ( string format ) : void
WriteLine ( ) : void
WriteLine ( string format ) : void

Method Details

ClientHelper_ReceivedServiceResponse() protected method

Client helper service response reception handler.
protected ClientHelper_ReceivedServiceResponse ( object sender, EventArgs e ) : void
sender object Sending object.
e EventArgs Event argument containing the service response.
return void

ClientHelper_ReceivedServiceUpdate() protected method

Client helper service update reception handler.
protected ClientHelper_ReceivedServiceUpdate ( object sender, string>.EventArgs e ) : void
sender object Sending object.
e string>.EventArgs Event argument containing update type and associated message data.
return void

ClientHelper_TelnetSessionEstablished() protected method

Client helper telnet session established handler.
protected ClientHelper_TelnetSessionEstablished ( object sender, EventArgs e ) : void
sender object Sending object.
e System.EventArgs Event arguments, if any.
return void

ClientHelper_TelnetSessionTerminated() protected method

Client helper telnet session terminated handler.
protected ClientHelper_TelnetSessionTerminated ( object sender, EventArgs e ) : void
sender object Sending object.
e System.EventArgs Event arguments, if any.
return void

Dispose() public method

Releases all the resources used by the ServiceClientBase object.
public Dispose ( ) : void
return void

Dispose() protected method

Releases the unmanaged resources used by the ServiceClientBase 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.
return void

Initialize() public method

Initializes the remoting client, client helper, and error logger.
public Initialize ( ) : void
return void

ServiceClientBase() public method

Creates a new instance of the ServiceClientBase class.
public ServiceClientBase ( ) : System
return System

Start() public method

Handles service start event.
public Start ( string args ) : void
args string Service start arguments.
return void