The client side interface with a UA server. More...

Inherits IDisposable.

Inherited by UnifiedAutomation.UaBase.DiscoveryClient, UnifiedAutomation.UaBase.RegistrationClient, and UnifiedAutomation.UaBase.SessionClient.

Public Member Functions
	ClientBase (ITransportChannel channel)
	Intializes the object with a channel and a message context. More...

void	Dispose ()
	Frees any unmanaged resources. More...

virtual void	Close ()
	Closes the channel. More...

Static Public Member Functions
static void	ValidateResponse (IList response, IList request)
	Validates a response returned by the server. More...

static void	ValidateDiagnosticInfos (DiagnosticInfoCollection response, IList request)
	Validates a response returned by the server. More...

Protected Member Functions
virtual void	Dispose (bool disposing)
	An overrideable version of the Dispose. More...

void	CloseChannel ()
	Closes the channel. More...

void	UpdateRequestHeader (IServiceRequest request, bool useDefaults, string serviceName)
	Updates the header of a service request. More...

virtual void	RequestCompleted (IServiceRequest request, IServiceResponse response, string serviceName)
	Called when a request completes. More...

Static Protected Member Functions
static void	ValidateResponse (ResponseHeader header)
	Throws an exception if a response contains an error. More...

static bool	IsTransportChannelRequired (EndpointDescription endpoint)
	Determines whether a transport channel required for the specified endpoint. More...

Properties
ITransportChannel	TransportChannel `[get, set]`
	Gets or set the channel being wrapped by the client object. More...

EndpointDescription	EndpointDescription `[get]`
	The channel being wrapped by the client object. More...

EndpointConfiguration	EndpointConfiguration `[get]`
	The channel being wrapped by the client object. More...

MessageContext	MessageContext `[get]`
	Gets the message context. More...

int	DefaultOperationTimeout `[get, set]`
	Sets the timeout for an operation. More...

bool	UseTransportChannel `[get]`
	Gets a value that indicates whether to use the TransportChannel when sending requests. More...

bool	Disposed `[get]`
	Whether the object has been disposed. More...

Detailed Description

The client side interface with a UA server.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ClientBase.ClientBase ( ITransportChannel channel )

inline

Intializes the object with a channel and a message context.

Parameters

channel The channel.

Member Function Documentation

virtual void UnifiedAutomation.UaBase.ClientBase.Close ( )

inlinevirtual

Closes the channel.

void UnifiedAutomation.UaBase.ClientBase.CloseChannel ( )

inlineprotected

Closes the channel.

void UnifiedAutomation.UaBase.ClientBase.Dispose ( )

inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaBase.ClientBase.Dispose ( bool disposing )

inlineprotectedvirtual

An overrideable version of the Dispose.

Parameters

disposing true to release both managed and unmanaged resources; false to release only unmanaged resources.

Reimplemented in UnifiedAutomation.UaBase.SessionClient.

static bool UnifiedAutomation.UaBase.ClientBase.IsTransportChannelRequired ( EndpointDescription endpoint )

inlinestaticprotected

Determines whether a transport channel required for the specified endpoint.

Parameters

endpoint The endpoint.

Returns: true if a transport channel required for thethe specified endpoint; otherwise, false.

Exceptions

System.ArgumentException endpoint

virtual void UnifiedAutomation.UaBase.ClientBase.RequestCompleted	(	IServiceRequest	request,
		IServiceResponse	response,
		string	serviceName
	)

inlineprotectedvirtual

Called when a request completes.

Parameters

request	The request.
response	The response.
serviceName	The name of the service.

void UnifiedAutomation.UaBase.ClientBase.UpdateRequestHeader	(	IServiceRequest	request,
		bool	useDefaults,
		string	serviceName
	)

inlineprotected

Updates the header of a service request.

Parameters

request	The request.
useDefaults	if set to `true` the no request header was provided.
serviceName	The name of the service.

static void UnifiedAutomation.UaBase.ClientBase.ValidateDiagnosticInfos	(	DiagnosticInfoCollection	response,
		IList	request
	)

inlinestatic

Validates a response returned by the server.

Parameters

response	The response.
request	The request.

static void UnifiedAutomation.UaBase.ClientBase.ValidateResponse ( ResponseHeader header )

inlinestaticprotected

Throws an exception if a response contains an error.

Parameters

header The header.

static void UnifiedAutomation.UaBase.ClientBase.ValidateResponse	(	IList	response,
		IList	request
	)

inlinestatic

Validates a response returned by the server.

Parameters

response	The response.
request	The request.

Property Documentation

int UnifiedAutomation.UaBase.ClientBase.DefaultOperationTimeout

getset

Sets the timeout for an operation.

bool UnifiedAutomation.UaBase.ClientBase.Disposed

get

Whether the object has been disposed.

true if disposed; otherwise, false.

EndpointConfiguration UnifiedAutomation.UaBase.ClientBase.EndpointConfiguration

get

The channel being wrapped by the client object.

EndpointDescription UnifiedAutomation.UaBase.ClientBase.EndpointDescription

get

The channel being wrapped by the client object.

MessageContext UnifiedAutomation.UaBase.ClientBase.MessageContext

get

Gets the message context.

ITransportChannel UnifiedAutomation.UaBase.ClientBase.TransportChannel

getset

Gets or set the channel being wrapped by the client object.

The transport channel.

bool UnifiedAutomation.UaBase.ClientBase.UseTransportChannel

getprotected

Gets a value that indicates whether to use the TransportChannel when sending requests.

The documentation for this class was generated from the following file:

C:/work/uasdknet/src/UaBase/Wcf/ClientBase.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation