UA Bundle SDK .NET  2.2.3.276
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.EndpointBase Class Reference

A base class for UA endpoints. More...

Inherits UnifiedAutomation.UaBase.IEndpointBase, and UnifiedAutomation.UaBase.ITransportListenerCallback.

Inherited by UnifiedAutomation.UaBase.DiscoveryEndpoint, and UnifiedAutomation.UaBase.SessionEndpoint.

Classes

class  ProcessRequestAsyncResult
 An AsyncResult object when handling an asynchronous request. More...
 
class  ServiceDefinition
 Stores the definition of a service supported by the server. More...
 

Public Member Functions

IAsyncResult BeginProcessRequest (string channeId, EndpointDescription endpointDescription, IServiceRequest request, AsyncCallback callback, object callbackData)
 Begins processing a request received via a binary encoded channel. More...
 
IServiceResponse EndProcessRequest (IAsyncResult result)
 Ends processing a request received via a binary encoded channel. More...
 
virtual IServiceResponse ProcessRequest (IServiceRequest incoming)
 Dispatches an incoming binary encoded request. More...
 
virtual IAsyncResult BeginInvokeService (InvokeServiceMessage message, AsyncCallback callack, object callbackData)
 Dispatches an incoming binary encoded request. More...
 
virtual
InvokeServiceResponseMessage 
EndInvokeService (IAsyncResult ar)
 Dispatches an incoming binary encoded request. More...
 

Protected Member Functions

 EndpointBase ()
 Initializes the object when it is created by the WCF framework. More...
 
 EndpointBase (ServerBase server)
 Initializes the endpoint with a server instead of a host. More...
 
IServerBase GetServerForContext ()
 Gets the server object from the operation context. More...
 
EndpointDescription GetEndpointDescription ()
 Find the endpoint description for the endpoint. More...
 
ServiceDefinition FindService (ExpandedNodeId requestTypeId)
 Finds the service identified by the request type. More...
 
void SetRequestContext (RequestEncoding encoding)
 Sets the request context for the thread. More...
 
virtual void OnRequestReceived (IServiceRequest request)
 Called when a new request is received by the endpoint. More...
 
virtual void OnResponseSent (IServiceResponse response)
 Called when a response sent via the endpoint. More...
 
virtual void OnResponseFaultSent (Exception fault)
 Called when a response fault sent via the endpoint. More...
 
delegate IServiceResponse InvokeServiceEventHandler (IServiceRequest request)
 A delegate used to dispatch incoming service requests. More...
 

Static Protected Member Functions

static IServiceHostBase GetHostForContext ()
 Returns the host associated with the current context. More...
 
static ServiceFault CreateFault (IServiceRequest request, Exception exception)
 Creates a fault message. More...
 
static Exception CreateSoapFault (IServiceRequest request, Exception exception)
 Creates a fault message. More...
 

Properties

IServiceHostBase HostForContext [get]
 Returns the host associated with the current context. More...
 
IServerBase ServerForContext [get]
 Gets the server object from the operation context. More...
 
EndpointDescription EndpointDescription [get, set]
 Returns the description for the endpoint More...
 
StatusCode ServerError [get, set]
 The types known to the server. More...
 
SortedList< ExpandedNodeId,
ServiceDefinition
SupportedServices [get, set]
 The types known to the server. More...
 

Detailed Description

A base class for UA endpoints.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.EndpointBase.EndpointBase ( )
inlineprotected

Initializes the object when it is created by the WCF framework.

UnifiedAutomation.UaBase.EndpointBase.EndpointBase ( ServerBase  server)
inlineprotected

Initializes the endpoint with a server instead of a host.

Member Function Documentation

virtual IAsyncResult UnifiedAutomation.UaBase.EndpointBase.BeginInvokeService ( InvokeServiceMessage  message,
AsyncCallback  callack,
object  callbackData 
)
inlinevirtual

Dispatches an incoming binary encoded request.

Implements UnifiedAutomation.UaBase.IEndpointBase.

IAsyncResult UnifiedAutomation.UaBase.EndpointBase.BeginProcessRequest ( string  channeId,
EndpointDescription  endpointDescription,
IServiceRequest  request,
AsyncCallback  callback,
object  callbackData 
)
inline

Begins processing a request received via a binary encoded channel.

Parameters
channeIdA unique identifier for the secure channel which is the source of the request.
endpointDescriptionThe description of the endpoint which the secure channel is using.
requestThe incoming request.
callbackThe callback.
callbackDataThe callback data.
Returns
The result which must be passed to the EndProcessRequest method.
See Also
EndProcessRequest, ITransportListener

Implements UnifiedAutomation.UaBase.ITransportListenerCallback.

static ServiceFault UnifiedAutomation.UaBase.EndpointBase.CreateFault ( IServiceRequest  request,
Exception  exception 
)
inlinestaticprotected

Creates a fault message.

Parameters
requestThe request.
exceptionThe exception.
Returns
A fault message.
static Exception UnifiedAutomation.UaBase.EndpointBase.CreateSoapFault ( IServiceRequest  request,
Exception  exception 
)
inlinestaticprotected

Creates a fault message.

Parameters
requestThe request.
exceptionThe exception.
Returns
A fault message.
virtual InvokeServiceResponseMessage UnifiedAutomation.UaBase.EndpointBase.EndInvokeService ( IAsyncResult  ar)
inlinevirtual

Dispatches an incoming binary encoded request.

Parameters
arThe ar.
Returns

Implements UnifiedAutomation.UaBase.IEndpointBase.

IServiceResponse UnifiedAutomation.UaBase.EndpointBase.EndProcessRequest ( IAsyncResult  result)
inline

Ends processing a request received via a binary encoded channel.

Parameters
resultThe result returned by the BeginProcessRequest method.
Returns
The response to return over the secure channel.
See Also
BeginProcessRequest

Implements UnifiedAutomation.UaBase.ITransportListenerCallback.

ServiceDefinition UnifiedAutomation.UaBase.EndpointBase.FindService ( ExpandedNodeId  requestTypeId)
inlineprotected

Finds the service identified by the request type.

EndpointDescription UnifiedAutomation.UaBase.EndpointBase.GetEndpointDescription ( )
inlineprotected

Find the endpoint description for the endpoint.

static IServiceHostBase UnifiedAutomation.UaBase.EndpointBase.GetHostForContext ( )
inlinestaticprotected

Returns the host associated with the current context.

Returns
The host associated with the current context.
IServerBase UnifiedAutomation.UaBase.EndpointBase.GetServerForContext ( )
inlineprotected

Gets the server object from the operation context.

Returns
The server object from the operation context.
delegate IServiceResponse UnifiedAutomation.UaBase.EndpointBase.InvokeServiceEventHandler ( IServiceRequest  request)
protected

A delegate used to dispatch incoming service requests.

virtual void UnifiedAutomation.UaBase.EndpointBase.OnRequestReceived ( IServiceRequest  request)
inlineprotectedvirtual

Called when a new request is received by the endpoint.

Parameters
requestThe request.
virtual void UnifiedAutomation.UaBase.EndpointBase.OnResponseFaultSent ( Exception  fault)
inlineprotectedvirtual

Called when a response fault sent via the endpoint.

Parameters
faultThe fault.
virtual void UnifiedAutomation.UaBase.EndpointBase.OnResponseSent ( IServiceResponse  response)
inlineprotectedvirtual

Called when a response sent via the endpoint.

Parameters
responseThe response.
virtual IServiceResponse UnifiedAutomation.UaBase.EndpointBase.ProcessRequest ( IServiceRequest  incoming)
inlinevirtual

Dispatches an incoming binary encoded request.

Parameters
incomingIncoming request.
void UnifiedAutomation.UaBase.EndpointBase.SetRequestContext ( RequestEncoding  encoding)
inlineprotected

Sets the request context for the thread.

Parameters
encodingThe encoding.

Property Documentation

EndpointDescription UnifiedAutomation.UaBase.EndpointBase.EndpointDescription
getsetprotected

Returns the description for the endpoint

The endpoint description.

IServiceHostBase UnifiedAutomation.UaBase.EndpointBase.HostForContext
getprotected

Returns the host associated with the current context.

The host associated with the current context.

StatusCode UnifiedAutomation.UaBase.EndpointBase.ServerError
getsetprotected

The types known to the server.

The server error.

IServerBase UnifiedAutomation.UaBase.EndpointBase.ServerForContext
getprotected

Gets the server object from the operation context.

The server object from the operation context.

SortedList<ExpandedNodeId,ServiceDefinition> UnifiedAutomation.UaBase.EndpointBase.SupportedServices
getsetprotected

The types known to the server.


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