UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.WcfChannelBase Class Referenceabstract

A base class for WCF channel objects used access UA interfaces More...

Inherits UnifiedAutomation.UaBase.IChannelBase, and UnifiedAutomation.UaBase.ITransportChannel.

Inherited by UnifiedAutomation.UaBase.WcfChannelBase< TChannel >.

Public Member Functions

 WcfChannelBase ()
 Initializes the object with the specified binding and endpoint address. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
void OpenChannel ()
 Opens the channel with the server. More...
 
void CloseChannel ()
 Closes the channel with the server. More...
 
void Initialize (Uri url, TransportChannelSettings settings)
 Initializes a secure channel with the endpoint identified by the URL. More...
 
IServiceResponse SendRequest (IServiceRequest request)
 Sends a request over the secure channel. More...
 
IAsyncResult BeginSendRequest (IServiceRequest request, AsyncCallback callback, object callbackData)
 Begins an asynchronous operation to send a request over the secure channel. More...
 
IServiceResponse EndSendRequest (IAsyncResult result)
 Completes an asynchronous operation to send a request over the secure channel. More...
 
void Close ()
 Closes the secure channel. More...
 
abstract
InvokeServiceResponseMessage 
InvokeService (InvokeServiceMessage request)
 The client side implementation of the InvokeService service contract. More...
 
abstract IAsyncResult BeginInvokeService (InvokeServiceMessage request, AsyncCallback callback, object asyncState)
 The client side implementation of the BeginInvokeService service contract. More...
 
abstract
InvokeServiceResponseMessage 
EndInvokeService (IAsyncResult result)
 The client side implementation of the EndInvokeService service contract. More...
 
StatusException HandleSoapFault (System.ServiceModel.FaultException< ServiceFault > exception)
 Converts a FaultException into a StatusException. More...
 

Static Public Member Functions

static ITransportChannel CreateTransportChannel (ApplicationInstance application, EndpointDescription description, EndpointConfiguration configuration, MessageContext context)
 Creates a new UA-binary transport channel if requested. Null otherwise. More...
 

Protected Member Functions

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

Properties

bool UseBinaryEncoding [get, set]
 Gets a value indicating that the binary encoding should be used with this channe. More...
 
EndpointDescription EndpointDescription [get]
 Gets the description for the endpoint used by the channel. More...
 
EndpointConfiguration EndpointConfiguration [get]
 Gets the configuration for the channel. More...
 
MessageContext MessageContext [get]
 Gets the context used when serializing messages exchanged via the channel. More...
 
int OperationTimeout [get, set]
 Gets or sets the default timeout for requests send via the channel. More...
 
- Properties inherited from UnifiedAutomation.UaBase.ITransportChannel
EndpointDescription EndpointDescription [get]
 Gets the description for the endpoint used by the channel. More...
 
EndpointConfiguration EndpointConfiguration [get]
 Gets the configuration for the channel. More...
 
MessageContext MessageContext [get]
 Gets the context used when serializing messages exchanged via the channel. More...
 
int OperationTimeout [get, set]
 Gets or sets the default timeout for requests send via the channel. More...
 

Detailed Description

A base class for WCF channel objects used access UA interfaces

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.WcfChannelBase.WcfChannelBase ( )
inline

Initializes the object with the specified binding and endpoint address.

Member Function Documentation

abstract IAsyncResult UnifiedAutomation.UaBase.WcfChannelBase.BeginInvokeService ( InvokeServiceMessage  request,
AsyncCallback  callback,
object  asyncState 
)
pure virtual

The client side implementation of the BeginInvokeService service contract.

Implements UnifiedAutomation.UaBase.IChannelBase.

Implemented in UnifiedAutomation.UaBase.WcfChannelBase< TChannel >.

IAsyncResult UnifiedAutomation.UaBase.WcfChannelBase.BeginSendRequest ( IServiceRequest  request,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins an asynchronous operation to send a request over the secure channel.

Implements UnifiedAutomation.UaBase.ITransportChannel.

void UnifiedAutomation.UaBase.WcfChannelBase.Close ( )
inline

Closes the secure channel.

Implements UnifiedAutomation.UaBase.ITransportChannel.

void UnifiedAutomation.UaBase.WcfChannelBase.CloseChannel ( )
inline

Closes the channel with the server.

static ITransportChannel UnifiedAutomation.UaBase.WcfChannelBase.CreateTransportChannel ( ApplicationInstance  application,
EndpointDescription  description,
EndpointConfiguration  configuration,
MessageContext  context 
)
inlinestatic

Creates a new UA-binary transport channel if requested. Null otherwise.

Parameters
applicationThe application.
descriptionThe description for the endpoint.
configurationThe application configuration.
contextThe request context.
Returns
void UnifiedAutomation.UaBase.WcfChannelBase.Dispose ( )
inline

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaBase.WcfChannelBase.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

Reimplemented in UnifiedAutomation.UaBase.WcfChannelBase< TChannel >.

abstract InvokeServiceResponseMessage UnifiedAutomation.UaBase.WcfChannelBase.EndInvokeService ( IAsyncResult  result)
pure virtual

The client side implementation of the EndInvokeService service contract.

Implements UnifiedAutomation.UaBase.IChannelBase.

Implemented in UnifiedAutomation.UaBase.WcfChannelBase< TChannel >.

IServiceResponse UnifiedAutomation.UaBase.WcfChannelBase.EndSendRequest ( IAsyncResult  result)
inline

Completes an asynchronous operation to send a request over the secure channel.

Implements UnifiedAutomation.UaBase.ITransportChannel.

StatusException UnifiedAutomation.UaBase.WcfChannelBase.HandleSoapFault ( System.ServiceModel.FaultException< ServiceFault exception)
inline

Converts a FaultException into a StatusException.

void UnifiedAutomation.UaBase.WcfChannelBase.Initialize ( Uri  url,
TransportChannelSettings  settings 
)
inline

Initializes a secure channel with the endpoint identified by the URL.

Parameters
urlThe URL for the endpoint.
settingsThe settings to use when creating the channel.
Exceptions
StatusExceptionThrown if any communication error occurs.

Implements UnifiedAutomation.UaBase.ITransportChannel.

abstract InvokeServiceResponseMessage UnifiedAutomation.UaBase.WcfChannelBase.InvokeService ( InvokeServiceMessage  request)
pure virtual

The client side implementation of the InvokeService service contract.

Implements UnifiedAutomation.UaBase.IChannelBase.

Implemented in UnifiedAutomation.UaBase.WcfChannelBase< TChannel >.

void UnifiedAutomation.UaBase.WcfChannelBase.OpenChannel ( )
inline

Opens the channel with the server.

IServiceResponse UnifiedAutomation.UaBase.WcfChannelBase.SendRequest ( IServiceRequest  request)
inline

Sends a request over the secure channel.

Implements UnifiedAutomation.UaBase.ITransportChannel.

Property Documentation

EndpointConfiguration UnifiedAutomation.UaBase.WcfChannelBase.EndpointConfiguration
get

Gets the configuration for the channel.

EndpointDescription UnifiedAutomation.UaBase.WcfChannelBase.EndpointDescription
get

Gets the description for the endpoint used by the channel.

MessageContext UnifiedAutomation.UaBase.WcfChannelBase.MessageContext
get

Gets the context used when serializing messages exchanged via the channel.

int UnifiedAutomation.UaBase.WcfChannelBase.OperationTimeout
getset

Gets or sets the default timeout for requests send via the channel.

bool UnifiedAutomation.UaBase.WcfChannelBase.UseBinaryEncoding
getset

Gets a value indicating that the binary encoding should be used with this channe.


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