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

An AsyncResult object when handling an asynchronous request. More...

Inherits UnifiedAutomation.UaBase.AsyncResultBase, and UnifiedAutomation.UaBase.IEndpointIncomingRequest.

Public Member Functions

 ProcessRequestAsyncResult (EndpointBase endpoint, AsyncCallback callback, object callbackData, int timeout)
 Initializes a new instance of the ProcessRequestAsyncResult class. More...
 
void CallSynchronously ()
 Used to call the default synchronous handler. More...
 
void OperationCompleted (IServiceResponse response, StatusCode error)
 Used to indicate that the asynchronous operation has completed. More...
 
IAsyncResult BeginProcessRequest (SecureChannelContext context, byte[] requestData)
 Begins processing an incoming request. More...
 
IAsyncResult BeginProcessRequest (SecureChannelContext context, IServiceRequest request)
 Begins processing an incoming request. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaBase.AsyncResultBase
 AsyncResultBase (AsyncCallback callback, object callbackData, int timeout)
 Initializes a new instance of the AsyncResultBase class. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
bool WaitForComplete ()
 Waits for the operation to complete. More...
 
void OperationCompleted ()
 Called to invoke the callback after the asynchronous operation completes. More...
 
void Fault (StatusCode statusCode)
 Called when a fault occurrs. More...
 
void Fault (Exception e)
 Called when a fault occurrs. More...
 

Static Public Member Functions

static IServiceResponse WaitForComplete (IAsyncResult ar, bool throwOnError)
 Checks for a valid IAsyncResult object and waits for the operation to complete. More...
 
static IServiceRequest GetRequest (IAsyncResult ar)
 Checks for a valid IAsyncResult object and returns the original request object. More...
 
- Static Public Member Functions inherited from UnifiedAutomation.UaBase.AsyncResultBase
static void WaitForComplete (IAsyncResult ar)
 Waits for the operation to complete. More...
 

Protected Member Functions

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

Properties

IServiceRequest Request [get]
 Gets the request. More...
 
IServiceResponse Response [get, set]
 Gets or sets the response. More...
 
SecureChannelContext SecureChannelContext [get]
 Gets the secure channel context associated with the request. More...
 
- Properties inherited from UnifiedAutomation.UaBase.AsyncResultBase
object Lock [get]
 An object used to synchronize access to the result object. More...
 
AsyncCallback Callback [get]
 The method to invoke when the request completes. More...
 
IAsyncResult InnerResult [get, set]
 An object used to synchronize access to the result object. More...
 
StatusCode Error [get]
 An error that occured during processing. More...
 
Exception Exception [get]
 An exception that occured during processing. More...
 
object AsyncState [get, set]
 Gets a user-defined object that qualifies or contains information about an asynchronous operation. More...
 
WaitHandle AsyncWaitHandle [get]
 Gets a T:System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete. More...
 
bool CompletedSynchronously [get]
 Gets a value that indicates whether the asynchronous operation completed synchronously. More...
 
bool IsCompleted [get]
 Gets a value that indicates whether the asynchronous operation has completed. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEndpointIncomingRequest
SecureChannelContext SecureChannelContext [get]
 Gets the secure channel context associated with the request. More...
 
IServiceRequest Request [get]
 Gets the request. More...
 
IServiceResponse Response [get, set]
 Gets or sets the response. More...
 

Detailed Description

An AsyncResult object when handling an asynchronous request.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.ProcessRequestAsyncResult ( EndpointBase  endpoint,
AsyncCallback  callback,
object  callbackData,
int  timeout 
)
inline

Initializes a new instance of the ProcessRequestAsyncResult class.

Parameters
endpointThe endpoint being called.
callbackThe callback to use when the operation completes.
callbackDataThe callback data.
timeoutThe timeout in milliseconds

Member Function Documentation

IAsyncResult UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.BeginProcessRequest ( SecureChannelContext  context,
byte[]  requestData 
)
inline

Begins processing an incoming request.

Parameters
contextThe security context for the request
requestDataThe request data.
Returns
The result object that is used to call the EndProcessRequest method.
IAsyncResult UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.BeginProcessRequest ( SecureChannelContext  context,
IServiceRequest  request 
)
inline

Begins processing an incoming request.

Parameters
contextThe security context for the request
requestThe request.
Returns
The result object that is used to call the EndProcessRequest method.
void UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.CallSynchronously ( )
inline

Used to call the default synchronous handler.

This method may block the current thread so the caller must not call in the thread that calls IServerBase.ScheduleIncomingRequest(). This method always traps any exceptions and reports them to the client as a fault.

Implements UnifiedAutomation.UaBase.IEndpointIncomingRequest.

override void UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.Dispose ( bool  disposing)
inlineprotectedvirtual

An overrideable version of the Dispose.

Reimplemented from UnifiedAutomation.UaBase.AsyncResultBase.

static IServiceRequest UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.GetRequest ( IAsyncResult  ar)
inlinestatic

Checks for a valid IAsyncResult object and returns the original request object.

Parameters
arThe IAsyncResult object for the operation.
Returns
The request object if available; otherwise null.
void UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.OperationCompleted ( IServiceResponse  response,
StatusCode  error 
)
inline

Used to indicate that the asynchronous operation has completed.

Parameters
responseThe response. May be null if an error is provided.
error

Implements UnifiedAutomation.UaBase.IEndpointIncomingRequest.

static IServiceResponse UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.WaitForComplete ( IAsyncResult  ar,
bool  throwOnError 
)
inlinestatic

Checks for a valid IAsyncResult object and waits for the operation to complete.

Parameters
arThe IAsyncResult object for the operation.
throwOnErrorif set to true an exception is thrown if an error occurred.
Returns
The response.

Property Documentation

IServiceRequest UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.Request
get

Gets the request.

The request.

IServiceResponse UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.Response
getset

Gets or sets the response.

The response.

SecureChannelContext UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.SecureChannelContext
get

Gets the secure channel context associated with the request.

The secure channel context.


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