C# Class GSF.TimeSeries.ServiceClientBase

Represents a client that can remotely access the time-series framework service host.

Inheritance: IDisposable

Show file 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.

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.

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

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

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

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

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

Releases all the resources used by the ServiceClientBase object.

public Dispose ( ) : void
return	void

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

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

public Initialize ( ) : void
return	void

Creates a new instance of the ServiceClientBase class.

public ServiceClientBase ( ) : System
return	System

Handles service start event.

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