The following tables list the members exposed by Session.
Public Constructors
| Name | Description | |
|---|---|---|
 | Session Constructor | Overloaded. |
Public Fields
| Name | Description | |
|---|---|---|
 | ReadMaxAgeDefault | The default maxAge for Read operations |
Public Properties
| Name | Description | |
|---|---|---|
 | CheckCertifcateDomain | If set to true then the domain in the certificate must match the gomain of the used endpoint. |
| ConfiguredEndpoint | Gets the endpoint used to connect to the server. |
| ConnectionStatus | Gets the server connection status. |
| DefaultRequestSettings | The RequestSettings used for the server access |
| DefunctRequestCount | Gets the number of outstanding publish or keep alive requests which appear to hung. |
| FilterContext | Gets the context to use for filter operations. |
| GoodPublishRequestCount | Gets the number of good outstanding publish requests. |
| Handle | Gets the local handle assigned to the session |
| Identity | Gets the user identity currently used for the session. |
| IdentityHistory | Gets a list of user identities that can be used to connect to the server. |
| LastStatusCheckTime | Gets the time of the last keep alive. |
| NamespaceIndexManagement | If set to TRUE (the default is false) then the node namespace indices are managed to stay valid even if change in the server. This is necessary if the client uses node IDs predefiend in code or an application configuration. The UA servers maintain a namespace URI table and the namespace index in the node IDs is the index in this table. The namespace URI table perssted in the client is compared with the current UA server namespace URI table and indices are adapted if the tables are different. |
| NamespaceUris | Gets the table of namespace uris known to the server. |
| NamespaceUrisPersisted | NamespaceURIs that match the NodeIDs persisted in the client application. Used ony if NamespaceIndexManagement == TRUE. If the application doesn't set this property before the Create() call then the URIs are tried to be loaded from the file 'appname.url.XML' in the same directory as the appname.exe executable. url is the UA server URL without the xxx:// If undefined and the file doesn't exist then the file is created with the current UA server namespace table. |
| OutstandingRequestCount | Gets the number of outstanding publish or keep alive requests. |
| PreferredLocales | Gets the locales that the server should use when returning localized text. |
| ReconnectPeriod | Gets or sets a imtervall in ms attempts are made to server after errors. |
| ServerUris | Gest the table of remote server uris known to the server. |
| SessionName | Gets the name assigned to the session. |
| SessionTimeout | Sets the requested maximum number of milliseconds that a Session should remain open without activity. If the Client fails to issue a Service request within this interval, then the Server shall automatically terminate the Client Session. After server Connect gets the actual maximum number of milliseconds that a Session shall remain open without activity. The Server should attempt to honour the Client request for this parameter, but may negotiate this value up or down to meet its own constraints. |
| StatusCheckInterval | Gets or Sets how frequently the server is pinged to see if communication is still working. |
| StatusCheckStopped | Returns true if the session is not receiving keep alives. |
| SubscriptionCount | Gets the number of subscriptions owned by the session. |
| SubscriptionPriority | Gets or sets the priority used in AddSubscription requests. |
| SubscriptionRequestKeepaliveCount | Gets or sets the requested maximum keep-alive count in AddSubscription. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count. |
| SubscriptionRequestLifetimeCount | Gets or sets the requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server. |
| Subscriptions | Gets the subscriptions owned by the session. |
| TimestampToReturn | Gets or sets the default timestamp to return. |
| TypeTree | Gets the cache of the server's type tree. |
Public Methods
| Name | Description | |
|---|---|---|
 | AddSubscription | Overloaded. Adds a new subscription to the session using default parameters. session.SubscriptionRequestKeepaliveCount session.SubscriptionRequestLifetimeCount session.SubscriptionPriority |
| BeginAddSubscription | Overloaded. Asynchronously adds a new subscription to the session using default parameters. session.SubscriptionRequestKeepaliveCount session.SubscriptionRequestLifetimeCount session.SubscriptionPriority |
| BeginBrowse | Begins an asynchronous invocation of the Browse service. |
| BeginBrowseNext | Begins an asynchronous invocation of the BrowseNext service. |
| BeginCall | Overloaded. Asynchronously calls the specified method and returns the output arguments. |
| BeginConnect | Asynchronically create the session in the UA server. |
| BeginGetUaMethodDefinition | |
| BeginHistoryDeleteAtTime | Begins an operation to delete the history for a list of variables for the passed timestamps. |
| BeginHistoryDeleteEvent | Begins an operation to delete the event history for a list of event notifier objects. |
| BeginHistoryDeleteRaw | Begins an operation to delete the history for a list of variables in the passed time domain. |
| BeginHistoryReadAtTime | Overloaded. Reads the history of item values asynchronously from the OPC server for the given timestamps. |
| BeginHistoryReadEvent | Overloaded. Begins an operation to read the event history for a list of notifiers. |
| BeginHistoryReadModified | Overloaded. Reads the history of modified variable values asynchronously from the OPC server. |
| BeginHistoryReadProcessed | Overloaded. Reads the processed history of variable values asynchronously from the OPC server based on a passed aggregate. |
| BeginHistoryReadRaw | Overloaded. Reads the history of variable values asynchronously from OPC server. |
| BeginHistoryUpdateData | Begins an operation to update the history for a list of variables. |
| BeginHistoryUpdateEvent | Begins an operation to update the history for a list of event notifier objects. |
| BeginHistoryUpdateStructureData | Begins an operation to update the history for a list of structured metadata variables. |
| BeginPublish | Sends an additional publish request. |
| BeginRead | Overloaded. Reads values and attributes asynchronously from OPC server. |
| BeginReadValue | Overloaded. Asynchronously reads the value attribute of the specified node. The server call is made with maxAge=0 and the TimestampsToReturn property. |
| BeginWriteAttribute | Overloaded. Writes attributes asynchronously to a OPC UA server. |
| BeginWriteAttributes | Overloaded. Writes attributes asynchronously to a OPC UA server. |
| Browse | Invokes the Browse service. |
| BrowseNext | Invokes the BrowseNext service. |
| Call | Overloaded. Calls the specified method and returns the output arguments. |
| CastToServerType | Converts the object to the data type specified by the UA data type NodeId. |
| ChangePreferredLocales | Updates the preferred locales used for the session. |
| Close | Overloaded. Disconnects from the server and frees any network resources. |
| Connect | Create the session in the UA server. |
| CreateBrowser | Create a browse helper class. |
| Dispose | |
| EndAddSubscription | Completes an asynchronous AddSubscription operation. |
| EndBrowse | Finishes an asynchronous invocation of the Browse service. |
| EndBrowseNext | Finishes an asynchronous invocation of the BrowseNext service. |
| EndCall | Get the result of an asynchronous method call. |
| EndConnect | Completes an asynchronous Connect operation. |
| EndGetUaMethodDefinition | Get the result of an asynchronous BeginGetUaMethodDefinition. |
| EndHistoryDeleteAtTime | Ends an operation to delete the history for a list of variables. |
| EndHistoryDeleteEvent | Ends an operation to delete the history for a list of variables. |
| EndHistoryDeleteRaw | Ends an operation to delete the history for a list of variables. |
| EndHistoryReadAtTime | Completes an asynchronous HistoryReadAtTime operation. |
| EndHistoryReadEvent | Ends an operation to read the event history for a list of notifiers. |
| EndHistoryReadModified | Completes an asynchronous HistoryReadModified operation. |
| EndHistoryReadProcessed | Completes an asynchronous HistoryReadProcessed operation. |
| EndHistoryReadRaw | Completes an asynchronous HistoryReadRaw operation. |
| EndHistoryUpdateData | Ends an operation to update the history for a list of variables. |
| EndHistoryUpdateEvent | Ends an operation to update the history for a list of event notifier objects. |
| EndHistoryUpdateStructureData | Ends an operation to update the history for a list of structured metadata variables. |
| EndRead | Completes an asynchronous read operation. |
| EndReadValue | Completes an asynchronous read operation. |
| EndWriteAttribute | Ends an asynchronous write operation. |
| EndWriteAttributes | Ends an asynchronous write operation. |
| FetchInverseReferences | Fetches the nodes that have a reference to the specified node. |
| FetchNamespaceTables | Updates the local copy of the server's namespace uri and server uri tables. |
| FetchReferences | Fetches all references for the specified node. |
| FetchTypeTree | Updates the cache with the type and its subtypes. |
| FindComponentIds | Finds the NodeIds for the components for an instance. |
| FindDataDescription | Returns the data description for the encoding. |
| FindDataDictionary | Returns the data dictionary that constains the description. |
| GetAsyncError | Retrieve the async handler exception indicator. |
| GetSystemType | Overloaded. Get the data type of the specified VariablNode as a System Type |
| GetUaMethodDefinition | Retrieve the argument definition for the method specified by the node identifier (item ID). |
| HistoryDeleteAtTime | Overloaded. Deletes the history for a list of variables for the passed timestamps. |
| HistoryDeleteEvent | Overloaded. Deletes the event history for a list of event notifier objects. |
| HistoryDeleteRaw | Overloaded. Deletes the history for a list of variables in the passed time domain. |
| HistoryReadAtTime | Overloaded. Reads the history of item values synchronously from the OPC server for the given timestamps. |
| HistoryReadEvent | Overloaded. Reads the event history for a list of event notifier objects synchronously from an OPC server. |
| HistoryReadModified | Overloaded. Reads the history of modified variable values synchronously from the OPC server. |
| HistoryReadProcessed | Overloaded. Reads the processed history of variable values synchronously from the OPC server based on a passed aggregate. |
| HistoryReadRaw | Overloaded. Reads the history of variable values synchronously from OPC server. |
| HistoryUpdateData | Overloaded. Updates the history for a list of variables. |
| HistoryUpdateEvent | Overloaded. Updates the event history for a list of event notifier objects. |
| HistoryUpdateStructureData | Overloaded. Updates the history for a list of for structured metadata variables. |
| MakeWriteValue | Builds a WriteValue object with the specified value. The value is converted to the datatype of this VariableNode in the server. |
| Read | Overloaded. Reads values and attributes synchronously from OPC server. The default requests settings are used. The timestamps are returned according the TimestampToReturn property (the default is SOURCE). MaxAge is set to 60000 (the cache value is returned unless the cache value is older than 1 minute). |
| ReadAttribute | Overloaded. Reads the value of the specified attribute of the specified node. The server call is made with maxAge=0 and the TimestampsToReturn property. |
| ReadAttributes | Reads the value of the specified attributes of the specified nodes. The server call is made with maxAge=0 and the TimestampsToReturn property. |
| ReadAvailableEncodings | Returns the available encodings for a node |
| ReadDisplayName | Reads the display name for a set of Nodes. |
| ReadNode | Reads the values for the node attributes and returns a Node object. The server call is made with maxAge=0 and TimestampsToReturn.Neither. |
| ReadNodes | Reads the values for the node attributes and returns a node object. The server call is made with maxAge=0 and TimestampsToReturn.Neither. |
| ReadValue | Reads the VALUE attribute of the specified node. The server call is made with maxAge=0 and the TimestampsToReturn property. |
| Reconnect | Reconnects to the server after a network failure. |
| RemoveSubscription | Removes a subscription from the session. |
| RemoveSubscriptions | Removes a list of subscriptions from the sessiont. |
| Republish | Sends a republish request. |
| Save | Saves a set of subscriptions. |
| UpdateSession | Updates the user identity and/or locales used for the session. |
| WriteAttribute | Writes one attribute synchronously to server. |
| WriteAttributes | Overloaded. Writes attributes synchronously to server. |
Public Events
| Name | Description | |
|---|---|---|
 | NotifyUntrustedCertificate | handler that is called when the server certificate is untrusted |
| PublishError | Raised when an exception occurs while processing a publish response. |
| PublishNotification | Raised when a notification message arrives in a publish response. |
| ReconnectComplete | Raised when a reconnect operation completes. |
| RenewUserIdentity | Raised before a reconnect operation completes. |
| SessionClosing | Raised to indicate the session is closing. |
| StatusChange | Raised when a StatusCheck server access failed or detected a changed server state. |
| SubscriptionsChanged | Raised when a subscription is added or removed |