ClientInfo Class

Represents information about a client using ClientHelper for connecting to a Windows Service that uses ServiceHelper.

Inheritance Hierarchy

SystemObject
GSF.ServiceProcessClientInfo

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

Syntax

[SerializableAttribute]
public class ClientInfo : ISerializable

<SerializableAttribute>
Public Class ClientInfo
	Implements ISerializable

[SerializableAttribute]
public ref class ClientInfo : ISerializable

[<SerializableAttribute>]
type ClientInfo = 
    class
        interface ISerializable
    end

GSF.ServiceProcess.ClientInfo = function();

Type.createClass(
	'GSF.ServiceProcess.ClientInfo',
	null,
	ISerializable);

The ClientInfo type exposes the following members.

Constructors

	Name	Description
	ClientInfo	Initializes a new instance of the ClientInfo class.
	ClientInfo(ClientHelper)	Initializes a new instance of the ClientInfo class.
	ClientInfo(SerializationInfo, StreamingContext)	Creates a new ClientInfo from serialization parameters.

Properties

	Name	Description
	ClientID	Gets the identifier of the remote client application.
	ClientName	Gets the friendly name of the remote client application.
	ClientPassword	Gets the password portion of the credentials supplied by the client.
	ClientType	Gets the ApplicationType of the remote client application.
	ClientUser	Gets the IPrincipal of the remote client application's user.
	ClientUserCredentials	Gets the credentials in 'username:password' format for authenticating the remote client application's user if a valid ClientUser is not available.
	ClientUsername	Gets the username portion of the credentials supplied by the client.
	ConnectedAt	Gets or sets the DateTime when the remote client application connected to the ServiceHelper.
	MachineName	Gets the name of the machine running the remote client application.
	SecureClientPassword	Gets the ClientPassword in a SecureString.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	SetClientUser	Updates the ClientUser.
	ToString	Returns a string that represents the current object. (Inherited from Object)

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)

Remarks

ClientInfo can be serialized and deserialized using BinaryFormatter only.