ClientHelper Class

Component that provides client-side functionality to ServiceHelper.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      GSF.ServiceProcessClientHelper

Namespace: GSF.ServiceProcess
Assembly: GSF.ServiceProcess (in GSF.ServiceProcess.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

[ToolboxBitmapAttribute(typeof(ClientHelper))]
public class ClientHelper : Component, 
	ISupportLifecycle, IDisposable, ISupportInitialize, IPersistSettings

<ToolboxBitmapAttribute(GetType(ClientHelper))>
Public Class ClientHelper
	Inherits Component
	Implements ISupportLifecycle, IDisposable, ISupportInitialize, IPersistSettings

[ToolboxBitmapAttribute(typeof(ClientHelper))]
public ref class ClientHelper : public Component, 
	ISupportLifecycle, IDisposable, ISupportInitialize, IPersistSettings

[<ToolboxBitmapAttribute(typeof(ClientHelper))>]
type ClientHelper = 
    class
        inherit Component
        interface ISupportLifecycle
        interface IDisposable
        interface ISupportInitialize
        interface IPersistSettings
    end

GSF.ServiceProcess.ClientHelper = function();

Type.createClass(
	'GSF.ServiceProcess.ClientHelper',
	Component,
	GSF.ISupportLifecycle,
	IDisposable,
	ISupportInitialize,
	GSF.Configuration.IPersistSettings);

View Source

The ClientHelper type exposes the following members.

Constructors

	Name	Description
	ClientHelper	Initializes a new instance of the ClientHelper class.
	ClientHelper(IContainer)	Initializes a new instance of the ClientHelper class.

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
	Container	Gets the IContainer that contains the Component. (Inherited from Component)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
	Enabled	Gets or sets a boolean value that indicates whether the ClientHelper is currently enabled.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
	IsDisposed	Gets a flag that indicates whether the object has been disposed.
	Password	Gets or sets the password of the ClientHelper's user to be used for authenticating is null the ServiceHelper.
	PersistSettings	Gets or sets a boolean value that indicates whether the settings of ClientHelper are to be saved to the config file.
	RemotingClient	Gets or sets the ClientBase object used for communicating with the ServiceHelper.
	SecurePassword	Gets or sets the password of the ClientHelper's user to be used for authenticating with the ServiceHelper.
	SerializationFormat	Gets or sets a value that indicates the desired message SerializationFormat for interaction with ServiceHelper.
	SettingsCategory	Gets or sets the category under which the settings of ClientHelper are to be saved to the config file if the PersistSettings property is set to true.
	Site	Gets or sets the ISite of the Component. (Inherited from Component)
	StatusMessageFilter	Gets or sets the command used to negotiate the status message filter with the service when the client connects.
	Username	Gets or sets the username of the ClientHelper's user to be used for authenticating with the ServiceHelper.

Top

Methods

	Name	Description
	BeginInit	Performs necessary operations before the ClientHelper properties are initialized.
	Connect	Connects RemotingClient to RemotingServer and wait until authentication is complete.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
	Disconnect	Disconnects RemotingClient from RemotingServer.
	Dispose	Releases all resources used by the Component. (Inherited from Component)
	Dispose(Boolean)	Releases the unmanaged resources used by the ClientHelper object and optionally releases the managed resources. (Overrides ComponentDispose(Boolean))
	EndInit	Performs necessary operations after the ClientHelper properties are initialized.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes the ClientHelper.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	LoadSettings	Loads saved settings for the ClientHelper from the config file if the PersistSettings property is set to true.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
	OnAuthenticationFailure	Raises the AuthenticationFailure event.
	OnAuthenticationSuccess	Raises the AuthenticationSuccess event.
	OnProcessStateChanged	Raises the ProcessStateChanged event.
	OnReceivedServiceResponse	Raises the ReceivedServiceResponse event.
	OnReceivedServiceUpdate	Raises the ReceivedServiceUpdate event.
	OnServiceStateChanged	Raises the ServiceStateChanged event.
	OnTelnetSessionEstablished	Raises the TelnetSessionEstablished event.
	OnTelnetSessionTerminated	Raises the TelnetSessionTerminated event.
	PretendRequest	Returns an ClientRequestInfo object for the specified requestCommand that can be used to invoke ClientRequestHandlers manually as if the request was sent by a ClientHelper remotely.
	SaveSettings	Saves settings for the ClientHelper to the config file if the PersistSettings property is set to true.
	SendRequest(ClientRequest)	Sends a request to the ServiceHelper using RemotingClient.
	SendRequest(String)	Sends a request to the ServiceHelper using RemotingClient.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
	TryParseActionableResponse	Attempts to parse an actionable response sent from the service.

Top

Events

	Name	Description
	AuthenticationFailure	Occurs when the ServiceHelper fails to authenticate the ClientHelper.
	AuthenticationSuccess	Occurs when the ServiceHelper successfully authenticates the ClientHelper.
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component)
	ProcessStateChanged	Occurs when the state of a ServiceProcess is changed.
	ReceivedServiceResponse	Occurs when a custom ServiceResponse is received from the ServiceHelper.
	ReceivedServiceUpdate	Occurs when a status update is received from the ServiceHelper.
	ServiceStateChanged	Occurs when the state of the ServiceHelper is changed.
	TelnetSessionEstablished	Occurs when a telnet session has been established.
	TelnetSessionTerminated	Occurs when a telnet session has been terminated.

Top

Fields

	Name	Description
	DefaultPassword	Specifies the default value for the Password property.
	DefaultPersistSettings	Specifies the default value for the PersistSettings property.
	DefaultSettingsCategory	Specifies the default value for the SettingsCategory property.
	DefaultStatusMessageFilter	Specifies the default value for the StatusMessageFilter property.
	DefaultUsername	Specifies the default value for the Username property.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.ServiceProcess Namespace