.NET Based OPC UA Client/Server SDK  3.3.3.537
Package UnifiedAutomation.UaClient

Classes

class  ActionFailedEventArgs
 EventArgs passed by EventHandler indicating failed GDS interactions. More...
 
class  ApplicationRegisteredEventArgs
 EventArgs passed by ApplicationRegistered. More...
 
class  BeforeConnectEventArgs
 
class  BrowseContext
 The context for a browse operation. More...
 
class  CacheManager
 Maintains a local cache of nodes and their attribute values. More...
 
class  CertificateDirectoryClient
 Used to access the CertificateDirectoryClient features of a GDS. More...
 
class  CertificateRequestPollingIntervals
 The polling intervals (in seconds) that can be used when requesting certificates. More...
 
class  ClientUtils
 Various utility functions for clients. More...
 
class  CredentialsRequiredEventArgs
 The arguments passed with a CredentialsRequiredEventArgs event. More...
 
class  DataChange
 A data change notification. More...
 
class  DataChangedEventArgs
 The event arguments provided when a DataChanged occurs. More...
 
class  DataMonitoredItem
 A data item being monitored. More...
 
class  DataTypeDescription
 The description of a data type. More...
 
class  DataTypeDictionary
 The description of a data type. More...
 
class  DataTypeDictionaryIdentity
 The description of a data type. More...
 
class  DataTypeManager
 An object which manages access to the data type dictionaries exposed by a server. More...
 
class  Discovery
 The settings for a request. More...
 
class  EventFilterStatus
 The status for an event filter. More...
 
class  EventMonitoredItem
 A data item being monitored. More...
 
class  FileDirectoryModel
 Used to access a File object on an OPC UA Server. More...
 
class  FileModel
 Used to access a File object on an OPC UA Server. More...
 
class  FileObjectStream
 Used to access a File object on an OPC UA Server. More...
 
class  FindServersOnNetworkResult
 The result of a FindServersOnNetwork operation. More...
 
class  FinishRequestResult
 The result a FinishRequest operation. More...
 
class  GdsPullManagement
 Automatically registers an application at a Global Discovery Server (GDS), requests the signing of the application instance certificate and updates the trust list if necessary. More...
 
class  GdsRegisterManagement
 Automatically registers an application at a Global Discovery Server. More...
 
class  HistoryDataReadResult
 A result for a history data read operation. More...
 
class  HistoryDataUpdateResult
 A result for a history data update operation. More...
 
class  HistoryEventReadResult
 A result for a history event read operation. More...
 
class  HistoryEventUpdateResult
 A result for a history event update operation. More...
 
class  InsecureCredentialsEventArgs
 The event arguments provided when a password is about to be sent over an insecure connection. More...
 
class  ItemEventFilter
 A filter for an Event monitored item. More...
 
class  MethodDescription
 Stores the information used to call a method. More...
 
class  MethodInvocation
 The method invocation. More...
 
class  MissingSequenceNumberEventArgs
 The event arguments provided when a MissingSequenceNumber occurs. More...
 
class  ModelManager
 Provides access to a UA information model using classes with special attributes defined. More...
 
class  ModelObjectChangedEventArgs
 A class that stores the argument passed to an ObjectChanged event. More...
 
class  ModelSubscription
 A class that represents a subscription to a model mapped object. More...
 
class  MonitoredItem
 An item being monitored. More...
 
class  MonitoredItemOperationCompleteEventArgs
 The event arguments provided when a RepublishError occurs. More...
 
class  NewEvent
 An event notification. More...
 
class  NewEventsEventArgs
 The event arguments provided when a NewEvents occurs. More...
 
class  NotificationMessageReceivedEventArgs
 The event arguments provided when a NotificationMessageReceived occurs. More...
 
class  PersistentStore
 The settings to use when saving or restoring data in a persistent store. More...
 
class  QueryContext
 The context for query operation. More...
 
class  QueryNextResult
 The result of a asynchronous query next operation. More...
 
class  QueryResult
 The result of a asynchronous query operation. More...
 
class  QueryValidationResult
 The results of a query operation. More...
 
class  RepublishErrorEventArgs
 The event arguments provided when a RepublishError occurs. More...
 
class  RequestSettings
 The settings for a request. More...
 
class  SelectClauseCollection
 A collection of select clauses. More...
 
class  ServerConfigurationClient
 Used to access the ServerConfigurationClient features of an OPC UA Server. More...
 
class  ServerConnectionStatusUpdateEventArgs
 The event arguments provided when a session validation error occurs. More...
 
class  Session
 A class that manages a session with an OPC UA server. More...
 
class  SessionMethodHelper
 This is a base class that manages a session used to call methods on the server. More...
 
class  SessionValidationEventArgs
 The event arguments provided when a session validation error occurs. More...
 
class  SetTriggeringResult
 Stores the operation level results returned in the response to a SetTriggering request. More...
 
class  Subscription
 A class that manages a subscription with an OPC UA server. More...
 
class  SubscriptionRecreatedEventArgs
 The event arguments provided when a Subscription is recreated More...
 
class  SubscriptionStatusChangedEventArgs
 The event arguments provided when a SubscriptionStatusChanged occurs. More...
 
class  TraceClient
 The trace class used by the UnifiedAutomation.UaClient namespace. More...
 
class  TraceClientModuleInfo
 The metadata for the UnifiedAutomation.UaClient trace object. More...
 
class  TransferFromSessionResult
 The results of a transfer subscriptions from session operation. More...
 
class  TrustListManagement
 Used to access a TrustList object in an OPC UA Server. More...
 
class  TypeDescription
 The description of a type. More...
 
class  TypeFieldDescription
 The description of a type field. More...
 
class  UpdateEndpointEventArgs
 The event arguments provided when a endpoint is about to be used to connect to a server. More...
 
class  UserIdentity
 A user identity. More...
 
class  WhereClauseCollection
 A collection of where clauses. More...
 

Enumerations

enum  SecuritySelection { SecuritySelection.None, SecuritySelection.BestAvailable }
 The options for selecting security. More...
 
enum  RetryInitialConnect { RetryInitialConnect.No, RetryInitialConnect.Yes }
 Whether to retry a failed connect in the background. More...
 
enum  TypeDescriptionSelection { TypeDescriptionSelection.Basic, TypeDescriptionSelection.FullyInherited }
 The options for selecting the type description. More...
 
enum  SubscriptionCleanupPolicy { SubscriptionCleanupPolicy.Keep, SubscriptionCleanupPolicy.Delete }
 The options for cleaning up subscriptions. More...
 
enum  ServerConnectionStatus {
  ServerConnectionStatus.Disconnected = 0, ServerConnectionStatus.Connected = 1, ServerConnectionStatus.ConnectionWarningWatchdogTimeout = 2, ServerConnectionStatus.ConnectionErrorClientReconnect = 3,
  ServerConnectionStatus.ServerShutdownInProgress = 4, ServerConnectionStatus.ServerShutdown = 5, ServerConnectionStatus.SessionAutomaticallyRecreated = 6, ServerConnectionStatus.Connecting = 7,
  ServerConnectionStatus.LicenseExpired = 8
}
 Information about the connection with the server. More...
 
enum  SubscriptionConnectionStatus {
  SubscriptionConnectionStatus.Deleted, SubscriptionConnectionStatus.Created, SubscriptionConnectionStatus.Transferring, SubscriptionConnectionStatus.Transferred,
  SubscriptionConnectionStatus.WarningKeepAliveLate, SubscriptionConnectionStatus.Error
}
 The possible states for a subscription. More...
 
enum  UserIdentityType {
  UserIdentityType.Anonymous, UserIdentityType.UserName, UserIdentityType.Certificate, UserIdentityType.Kerberos,
  UserIdentityType.XmlToken
}
 The possible use identity types. More...
 

Functions

delegate void ServerConnectionStatusUpdateEventHandler (Session sender, ServerConnectionStatusUpdateEventArgs e)
 Used to handled changes to the connection state. More...
 
delegate void SessionValidationEventHandler (Session sender, SessionValidationEventArgs e)
 Used to handled session validation errors. More...
 
delegate void UpdateEndpointEventHandler (Session sender, UpdateEndpointEventArgs e)
 Used to handled update endpoint events. More...
 
delegate void InsecureCredentialsEventHandler (Session sender, InsecureCredentialsEventArgs e)
 Used to handle insecure password events. More...
 
delegate void DataChangedEventHandler (Subscription subscription, DataChangedEventArgs e)
 Used to handle DataChanged events. More...
 
delegate void NewEventsEventHandler (Subscription subscription, NewEventsEventArgs e)
 Used to handle NewEvents events.

Parameters
subscriptionThe subscription object that contains the MonitoredItems passed in the NewEvents of e.
eThe information about the new events.
More...
 
delegate void NotificationMessageReceivedEventHandler (Subscription subscription, NotificationMessageReceivedEventArgs e)
 Used to handle NotificationMessageReceived events. More...
 
delegate void MissingSequenceNumberEventHandler (Subscription subscription, MissingSequenceNumberEventArgs e)
 Used to report missing messages. More...
 
delegate void SubscriptionRecreatedEventHandler (Subscription subscription, SubscriptionRecreatedEventArgs e)
 Used to report if a subscription has been recreated More...
 
delegate void RepublishErrorEventHandler (Subscription subscription, RepublishErrorEventArgs e)
 Used to report missing messages. More...
 
delegate void SubscriptionStatusChangedEventHandler (Subscription subscription, SubscriptionStatusChangedEventArgs e)
 Used to report status change events. More...
 
delegate void MonitoredItemOperationCompleteEventHandler (Subscription subscription, MonitoredItemOperationCompleteEventArgs e)
 Used to report missing messages. More...
 

Enumeration Type Documentation

The possible use identity types.

Enumerator
Anonymous 

No user identity is available.

UserName 

The user identity is a user name and password.

Certificate 

The user identity is an X509 certificate.

Kerberos 

The user identity is integrated windows authentication via Kerberos.

XmlToken 

The user identity a WS-* compliant XML token.

Function Documentation

delegate void UnifiedAutomation.UaClient.DataChangedEventHandler ( Subscription  subscription,
DataChangedEventArgs  e 
)

Used to handle DataChanged events.

Parameters
subscriptionThe subscription object that contains the MonitoredItems passed in the DataChanges of e.
eThe information about the changed values.
delegate void UnifiedAutomation.UaClient.InsecureCredentialsEventHandler ( Session  sender,
InsecureCredentialsEventArgs  e 
)

Used to handle insecure password events.

delegate void UnifiedAutomation.UaClient.MissingSequenceNumberEventHandler ( Subscription  subscription,
MissingSequenceNumberEventArgs  e 
)

Used to report missing messages.

Parameters
subscriptionThe subscription with missing sequence numbers.
eThe sequence number information.
delegate void UnifiedAutomation.UaClient.MonitoredItemOperationCompleteEventHandler ( Subscription  subscription,
MonitoredItemOperationCompleteEventArgs  e 
)

Used to report missing messages.

delegate void UnifiedAutomation.UaClient.NewEventsEventHandler ( Subscription  subscription,
NewEventsEventArgs  e 
)

Used to handle NewEvents events.

Parameters
subscriptionThe subscription object that contains the MonitoredItems passed in the NewEvents of e.
eThe information about the new events.

delegate void UnifiedAutomation.UaClient.NotificationMessageReceivedEventHandler ( Subscription  subscription,
NotificationMessageReceivedEventArgs  e 
)

Used to handle NotificationMessageReceived events.

Parameters
subscriptionThe subscription.
eThe UnifiedAutomation.UaClient.NotificationMessageReceivedEventArgs instance containing the event data.
delegate void UnifiedAutomation.UaClient.RepublishErrorEventHandler ( Subscription  subscription,
RepublishErrorEventArgs  e 
)

Used to report missing messages.

delegate void UnifiedAutomation.UaClient.ServerConnectionStatusUpdateEventHandler ( Session  sender,
ServerConnectionStatusUpdateEventArgs  e 
)

Used to handled changes to the connection state.

delegate void UnifiedAutomation.UaClient.SessionValidationEventHandler ( Session  sender,
SessionValidationEventArgs  e 
)

Used to handled session validation errors.

delegate void UnifiedAutomation.UaClient.SubscriptionRecreatedEventHandler ( Subscription  subscription,
SubscriptionRecreatedEventArgs  e 
)

Used to report if a subscription has been recreated

Parameters
subscriptionThe subscription with missing sequence numbers.
eThe e
delegate void UnifiedAutomation.UaClient.SubscriptionStatusChangedEventHandler ( Subscription  subscription,
SubscriptionStatusChangedEventArgs  e 
)

Used to report status change events.

delegate void UnifiedAutomation.UaClient.UpdateEndpointEventHandler ( Session  sender,
UpdateEndpointEventArgs  e 
)

Used to handled update endpoint events.