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

A base class for AsyncResult objects More...

Inherits IAsyncResult, and IDisposable.

Inherited by UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult, UnifiedAutomation.UaClient.Discovery.FindServersAsyncResult, UnifiedAutomation.UaClient.Discovery.GetEndpointsAsyncResult, UnifiedAutomation.UaClient.MetadataMapper.GetMethodDescriptionAsyncResult, UnifiedAutomation.UaClient.MetadataMapper.GetTypeDescriptionAsyncResult, UnifiedAutomation.UaClient.MetadataMapper.ReadAsyncResult, UnifiedAutomation.UaClient.MetadataMapper.WriteAsyncResult, UnifiedAutomation.UaClient.ModelManager.GetMethodDescriptionAsyncResult, UnifiedAutomation.UaClient.ModelManager.GetTypeDescriptionAsyncResult, UnifiedAutomation.UaClient.ModelManager.ReadAsyncResult, UnifiedAutomation.UaClient.ModelManager.WriteAsyncResult, UnifiedAutomation.UaClient.Session.AddNodesAsyncResult, UnifiedAutomation.UaClient.Session.AddReferencesAsyncResult, UnifiedAutomation.UaClient.Session.BrowseAsyncResult, UnifiedAutomation.UaClient.Session.BrowseListAsyncResult, UnifiedAutomation.UaClient.Session.CallListAsyncResult, UnifiedAutomation.UaClient.Session.ChangeUserAsyncResult, UnifiedAutomation.UaClient.Session.ConnectAsyncResult, UnifiedAutomation.UaClient.Session.CreateMonitoredItemsAsyncResult, UnifiedAutomation.UaClient.Session.CreateSubscriptionAsyncResult, UnifiedAutomation.UaClient.Session.DeleteMonitoredItemsAsyncResult, UnifiedAutomation.UaClient.Session.DeleteNodesAsyncResult, UnifiedAutomation.UaClient.Session.DeleteReferencesAsyncResult, UnifiedAutomation.UaClient.Session.DeleteSubscriptionAsyncResult, UnifiedAutomation.UaClient.Session.DisconnectAsyncResult, UnifiedAutomation.UaClient.Session.HistoryReadDataAsyncResult, UnifiedAutomation.UaClient.Session.HistoryReadEventAsyncResult, UnifiedAutomation.UaClient.Session.HistoryUpdateDataAsyncResult, UnifiedAutomation.UaClient.Session.HistoryUpdateEventAsyncResult, UnifiedAutomation.UaClient.Session.ModifyMonitoredItemsAsyncResult, UnifiedAutomation.UaClient.Session.ModifySubscriptionAsyncResult, UnifiedAutomation.UaClient.Session.PublishAsyncResult, UnifiedAutomation.UaClient.Session.ReactivateAsyncResult, UnifiedAutomation.UaClient.Session.ReadAsyncResult, UnifiedAutomation.UaClient.Session.RegisterNodesAsyncResult, UnifiedAutomation.UaClient.Session.RepublishAsyncResult, UnifiedAutomation.UaClient.Session.SetMonitoringModeAsyncResult, UnifiedAutomation.UaClient.Session.SetPublishingModeAsyncResult, UnifiedAutomation.UaClient.Session.TransferSubscriptionAsyncResult, UnifiedAutomation.UaClient.Session.TranslateBrowsePathAsyncResult, UnifiedAutomation.UaClient.Session.UnregisterNodesAsyncResult, UnifiedAutomation.UaClient.Session.WriteAsyncResult, UnifiedAutomation.UaClient.Subscription.CreateMonitoredItemsAsyncResult, UnifiedAutomation.UaClient.Subscription.ModifyAsyncResult, UnifiedAutomation.UaClient.Subscription.RepublishAsyncResult, and UnifiedAutomation.UaClient.Subscription.TransferCallbackData.

Public Member Functions

 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 void WaitForComplete (IAsyncResult ar)
 Waits for the operation to complete. More...
 

Protected Member Functions

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

Properties

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...
 

Detailed Description

A base class for AsyncResult objects

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.AsyncResultBase.AsyncResultBase ( AsyncCallback  callback,
object  callbackData,
int  timeout 
)
inline

Initializes a new instance of the AsyncResultBase class.

Parameters
callbackThe callback to use when the operation completes.
callbackDataThe callback data.
timeoutThe timeout for the operation.

Member Function Documentation

void UnifiedAutomation.UaBase.AsyncResultBase.Dispose ( )
inline

Frees any unmanaged resources.

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

An overrideable version of the Dispose.

Reimplemented in UnifiedAutomation.UaBase.EndpointBase.ProcessRequestAsyncResult.

void UnifiedAutomation.UaBase.AsyncResultBase.Fault ( StatusCode  statusCode)
inline

Called when a fault occurrs.

void UnifiedAutomation.UaBase.AsyncResultBase.Fault ( Exception  e)
inline

Called when a fault occurrs.

void UnifiedAutomation.UaBase.AsyncResultBase.OperationCompleted ( )
inline

Called to invoke the callback after the asynchronous operation completes.

static void UnifiedAutomation.UaBase.AsyncResultBase.WaitForComplete ( IAsyncResult  ar)
inlinestatic

Waits for the operation to complete.

Parameters
arThe result object returned from the Begin method.
bool UnifiedAutomation.UaBase.AsyncResultBase.WaitForComplete ( )
inline

Waits for the operation to complete.

Returns
True if operation completed without any errors.

Property Documentation

object UnifiedAutomation.UaBase.AsyncResultBase.AsyncState
getset

Gets a user-defined object that qualifies or contains information about an asynchronous operation.

Returns
A user-defined object that qualifies or contains information about an asynchronous operation.
WaitHandle UnifiedAutomation.UaBase.AsyncResultBase.AsyncWaitHandle
get

Gets a T:System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete.

Returns
A T:System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete.
AsyncCallback UnifiedAutomation.UaBase.AsyncResultBase.Callback
get

The method to invoke when the request completes.

bool UnifiedAutomation.UaBase.AsyncResultBase.CompletedSynchronously
get

Gets a value that indicates whether the asynchronous operation completed synchronously.

Returns
true if the asynchronous operation completed synchronously; otherwise, false.
StatusCode UnifiedAutomation.UaBase.AsyncResultBase.Error
get

An error that occured during processing.

Exception UnifiedAutomation.UaBase.AsyncResultBase.Exception
get

An exception that occured during processing.

IAsyncResult UnifiedAutomation.UaBase.AsyncResultBase.InnerResult
getset

An object used to synchronize access to the result object.

bool UnifiedAutomation.UaBase.AsyncResultBase.IsCompleted
get

Gets a value that indicates whether the asynchronous operation has completed.

Returns
true if the operation is complete; otherwise, false.
object UnifiedAutomation.UaBase.AsyncResultBase.Lock
get

An object used to synchronize access to the result object.


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