Build 1.01.318.0
[This is preliminary documentation and is subject to change.]
The Session type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| Session(ISessionChannel, ApplicationConfiguration, ConfiguredEndpoint) |
Constructs a new instance of the session.
| |
| Session(ITransportChannel, Session, Boolean) |
Initializes a new instance of the Session class.
| |
| Session(ITransportChannel, ApplicationConfiguration, ConfiguredEndpoint, X509Certificate2) |
Constructs a new instance of the session.
|
Methods
| Name | Description | |
|---|---|---|
| AddSubscription |
Adds a subscription to the session.
| |
| BeginBrowse |
Begins an asynchronous invocation of the Browse service.
| |
| BeginBrowseNext |
Begins an asynchronous invocation of the BrowseNext service.
| |
| BeginPublish |
Sends an additional publish request.
| |
| Browse |
Invokes the Browse service.
| |
| BrowseNext |
Invokes the BrowseNext service.
| |
| Call |
Calls the specified method and returns the output arguments.
| |
| ChangePreferredLocales |
Updates the preferred locales used for the session.
| |
| Close()()()() |
Disconnects from the server and frees any network resources.
(Overrides ClientBase..::..Close()()()().) | |
| Close(Int32) |
Disconnects from the server and frees any network resources.
| |
| CloseChannel |
Closes the channel.
(Inherited from ClientBase.) | |
| Create |
Creates a new session with a server.
| |
| CreateAuditLogEntry |
Creates an audit log entry for the request.
(Inherited from ClientBase.) | |
| Dispose()()()() |
Frees any unmanaged resources.
(Inherited from ClientBase.) | |
| Dispose(Boolean) |
Closes the session and the underlying channel.
(Overrides SessionClientDispose(Boolean).) | |
| EndBrowse |
Finishes an asynchronous invocation of the Browse service.
| |
| EndBrowseNext |
Finishes an asynchronous invocation of the BrowseNext service.
| |
| Equals | (Inherited from Object.) | |
| 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.
| |
| Finalize |
The finializer implementation.
(Inherited from ClientBase.) | |
| 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.
| |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetSoftwareCertificates |
Returns the software certificates assigned to the application.
| |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| Load |
Load the subscriptions saved in the files.
| |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| OnApplicationCertificateError |
Handles an error when validating the application instance certificate provided by the server.
| |
| OnKeepAlive |
Called when the server returns a keep alive response.
| |
| OnKeepAliveError |
Called when a error occurs during a keep alive.
| |
| OnSoftwareCertificateError |
Handles an error when validating software certificates provided by the server.
| |
| Open(String, IUserIdentity) |
Establishes a session with the server.
| |
| Open(String, UInt32, IUserIdentity, IList<(Of <<'(String>)>>)) |
Establishes a session with the server.
| |
| ReadAvailableEncodings |
Returns the available encodings for a node
| |
| ReadDisplayName |
Reads the values for a set of variables.
| |
| ReadNode |
Reads the values for the node attributes and returns a node object.
| |
| ReadValue(NodeId) |
Reads the value for a node.
| |
| ReadValue(NodeId, Type) |
Reads the value for a node an checks that it is the specified type.
| |
| ReadValues |
Reads the values for a set of variables.
| |
| Reconnect |
Reconnects to the server after a network failure.
| |
| Recreate |
Recreates the session based on the template.
| |
| RemoveSubscription |
Removes a subscription from the sessiont.
| |
| RemoveSubscriptions |
Removes a list of subscriptions from the sessiont.
| |
| Republish |
Sends a republish request.
| |
| RequestCompleted |
Called when a request completes.
(Inherited from ClientBase.) | |
| Save(String) |
Saves a all subscriptions for the session.
| |
| Save(String, IEnumerable<(Of <<'(Subscription>)>>)) |
Saves a set of subscriptions.
| |
| ToString | (Inherited from Object.) | |
| UpdateRequestHeader(IServiceRequest) | Obsolete.
Updates the header of a service request.
(Inherited from ClientBase.) | |
| UpdateRequestHeader(IServiceRequest, Boolean) |
Updates the header of a service request.
(Inherited from ClientBase.) | |
| UpdateRequestHeader(IServiceRequest, Boolean, String) |
Updates the header of a service request.
(Inherited from ClientBase.) | |
| UpdateSession |
Updates the user identity and/or locales used for the session.
| |
| ValidateSoftwareCertificates |
Inspects the software certificates provided by the server.
|
Properties
| Name | Description | |
|---|---|---|
| AuthenticationToken |
The authorization token used to connect to the server.
(Inherited from ClientBase.) | |
| ConfiguredEndpoint |
The endpoint used to connect to the server.
| |
| DefaultSubscription |
The default subscription for the session.
| |
| DefunctRequestCount |
The number of outstanding publish or keep alive requests which appear to hung.
| |
| Disposed |
Whether the object has been disposed.
(Inherited from ClientBase.) | |
| Endpoint |
The description of the endpoint.
(Inherited from ClientBase.) | |
| EndpointConfiguration |
The configuration for the endpoint.
(Inherited from ClientBase.) | |
| Factory |
The factory used to create encodeable objects that the server understands.
| |
| FilterContext |
The context to use for filter operations.
| |
| GoodPublishRequestCount |
The number of good outstanding publish requests.
| |
| Handle |
A local handle assigned to the session
| |
| Identity |
The identity current used for the session.
| |
| IdentityHistory |
A list of user identities that can be used to connect to the server.
| |
| KeepAliveInterval |
How frequently the server is pinged to see if communication is still working.
| |
| KeepAliveStopped |
Returns true if the session is not receiving keep alives.
| |
| LastKeepAliveTime |
Gets the time of the last keep alive.
| |
| MessageContext |
The message context used when serializing messages.
(Inherited from ClientBase.) | |
| NamespaceUris |
The table of namespace uris known to the server.
| |
| NodeCache |
A cache of nodes fetched from the server.
| |
| OperationTimeout |
Sets the timeout for an operation.
(Inherited from ClientBase.) | |
| OutstandingRequestCount |
The number of outstanding publish or keep alive requests.
| |
| PreferredLocales |
The locales that the server should use when returning localized text.
| |
| ReturnDiagnostics |
What diagnostics the server should return in the response.
(Inherited from ClientBase.) | |
| ServerUris |
The table of remote server uris known to the server.
| |
| SessionName |
The name assigned to the session.
| |
| SessionTimeout |
How long the server will maintain the session if there is no communication from the client.
| |
| SubscriptionCount |
The number of subscriptions owned by the session.
| |
| Subscriptions |
The subscriptions owned by the session.
| |
| SyncRoot |
An object used to synchronize access to the session state.
(Inherited from ClientBase.) | |
| SystemContext |
The system context for use with the session.
| |
| TransportChannel |
Gets or set the channel being wrapped by the client object.
(Inherited from ClientBase.) | |
| TypeTree |
A cache of the server's type tree.
| |
| UseTransportChannel |
Gets a value that indicates whether to use the TransportChannel when sending requests.
(Inherited from ClientBase.) |
Events
| Name | Description | |
|---|---|---|
| KeepAlive |
Raised when a keep alive arrives from the server or an error is detected.
| |
| Notification |
Raised when a notification message arrives in a publish response.
| |
| PublishError |
Raised when an exception occurs while processing a publish response.
| |
| RenewUserIdentity |
Occurs before a reconnect operation completes.
| |
| SessionClosing |
Raised to indicate the session is closing.
| |
| SubscriptionsChanged |
Raised when a subscription is added or removed
|