Build 1.01.318.0

[This is preliminary documentation and is subject to change.]

The Session type exposes the following members.

Constructors

  NameDescription
Public methodSession(ISessionChannel, ApplicationConfiguration, ConfiguredEndpoint)
Constructs a new instance of the session.
Public methodSession(ITransportChannel, Session, Boolean)
Initializes a new instance of the Session class.
Public methodSession(ITransportChannel, ApplicationConfiguration, ConfiguredEndpoint, X509Certificate2)
Constructs a new instance of the session.

Methods

  NameDescription
Public methodAddSubscription
Adds a subscription to the session.
Public methodBeginBrowse
Begins an asynchronous invocation of the Browse service.
Public methodBeginBrowseNext
Begins an asynchronous invocation of the BrowseNext service.
Public methodBeginPublish
Sends an additional publish request.
Public methodBrowse
Invokes the Browse service.
Public methodBrowseNext
Invokes the BrowseNext service.
Public methodCall
Calls the specified method and returns the output arguments.
Public methodChangePreferredLocales
Updates the preferred locales used for the session.
Public methodClose()()()()
Disconnects from the server and frees any network resources.
(Overrides ClientBase..::..Close()()()().)
Public methodClose(Int32)
Disconnects from the server and frees any network resources.
Protected methodCloseChannel
Closes the channel.
(Inherited from ClientBase.)
Public methodStatic memberCreate
Creates a new session with a server.
Protected methodCreateAuditLogEntry
Creates an audit log entry for the request.
(Inherited from ClientBase.)
Public methodDispose()()()()
Frees any unmanaged resources.
(Inherited from ClientBase.)
Protected methodDispose(Boolean)
Closes the session and the underlying channel.
(Overrides SessionClientDispose(Boolean).)
Public methodEndBrowse
Finishes an asynchronous invocation of the Browse service.
Public methodEndBrowseNext
Finishes an asynchronous invocation of the BrowseNext service.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFetchNamespaceTables
Updates the local copy of the server's namespace uri and server uri tables.
Public methodFetchReferences
Fetches all references for the specified node.
Public methodFetchTypeTree
Updates the cache with the type and its subtypes.
Protected methodFinalize
The finializer implementation.
(Inherited from ClientBase.)
Public methodFindComponentIds
Finds the NodeIds for the components for an instance.
Public methodFindDataDescription
Returns the data description for the encoding.
Public methodFindDataDictionary
Returns the data dictionary that constains the description.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetSoftwareCertificates
Returns the software certificates assigned to the application.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoad
Load the subscriptions saved in the files.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnApplicationCertificateError
Handles an error when validating the application instance certificate provided by the server.
Protected methodOnKeepAlive
Called when the server returns a keep alive response.
Protected methodOnKeepAliveError
Called when a error occurs during a keep alive.
Protected methodOnSoftwareCertificateError
Handles an error when validating software certificates provided by the server.
Public methodOpen(String, IUserIdentity)
Establishes a session with the server.
Public methodOpen(String, UInt32, IUserIdentity, IList<(Of <<'(String>)>>))
Establishes a session with the server.
Public methodReadAvailableEncodings
Returns the available encodings for a node
Public methodReadDisplayName
Reads the values for a set of variables.
Public methodReadNode
Reads the values for the node attributes and returns a node object.
Public methodReadValue(NodeId)
Reads the value for a node.
Public methodReadValue(NodeId, Type)
Reads the value for a node an checks that it is the specified type.
Public methodReadValues
Reads the values for a set of variables.
Public methodReconnect
Reconnects to the server after a network failure.
Public methodStatic memberRecreate
Recreates the session based on the template.
Public methodRemoveSubscription
Removes a subscription from the sessiont.
Public methodRemoveSubscriptions
Removes a list of subscriptions from the sessiont.
Public methodRepublish
Sends a republish request.
Protected methodRequestCompleted
Called when a request completes.
(Inherited from ClientBase.)
Public methodSave(String)
Saves a all subscriptions for the session.
Public methodSave(String, IEnumerable<(Of <<'(Subscription>)>>))
Saves a set of subscriptions.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Protected methodUpdateRequestHeader(IServiceRequest) Obsolete.
Updates the header of a service request.
(Inherited from ClientBase.)
Protected methodUpdateRequestHeader(IServiceRequest, Boolean)
Updates the header of a service request.
(Inherited from ClientBase.)
Protected methodUpdateRequestHeader(IServiceRequest, Boolean, String)
Updates the header of a service request.
(Inherited from ClientBase.)
Public methodUpdateSession
Updates the user identity and/or locales used for the session.
Protected methodValidateSoftwareCertificates
Inspects the software certificates provided by the server.

Properties

  NameDescription
Protected propertyAuthenticationToken
The authorization token used to connect to the server.
(Inherited from ClientBase.)
Public propertyConfiguredEndpoint
The endpoint used to connect to the server.
Public propertyDefaultSubscription
The default subscription for the session.
Public propertyDefunctRequestCount
The number of outstanding publish or keep alive requests which appear to hung.
Public propertyDisposed
Whether the object has been disposed.
(Inherited from ClientBase.)
Public propertyEndpoint
The description of the endpoint.
(Inherited from ClientBase.)
Public propertyEndpointConfiguration
The configuration for the endpoint.
(Inherited from ClientBase.)
Public propertyFactory
The factory used to create encodeable objects that the server understands.
Public propertyFilterContext
The context to use for filter operations.
Public propertyGoodPublishRequestCount
The number of good outstanding publish requests.
Public propertyHandle
A local handle assigned to the session
Public propertyIdentity
The identity current used for the session.
Public propertyIdentityHistory
A list of user identities that can be used to connect to the server.
Public propertyKeepAliveInterval
How frequently the server is pinged to see if communication is still working.
Public propertyKeepAliveStopped
Returns true if the session is not receiving keep alives.
Public propertyLastKeepAliveTime
Gets the time of the last keep alive.
Public propertyMessageContext
The message context used when serializing messages.
(Inherited from ClientBase.)
Public propertyNamespaceUris
The table of namespace uris known to the server.
Public propertyNodeCache
A cache of nodes fetched from the server.
Public propertyOperationTimeout
Sets the timeout for an operation.
(Inherited from ClientBase.)
Public propertyOutstandingRequestCount
The number of outstanding publish or keep alive requests.
Public propertyPreferredLocales
The locales that the server should use when returning localized text.
Public propertyReturnDiagnostics
What diagnostics the server should return in the response.
(Inherited from ClientBase.)
Public propertyServerUris
The table of remote server uris known to the server.
Public propertySessionName
The name assigned to the session.
Public propertySessionTimeout
How long the server will maintain the session if there is no communication from the client.
Public propertySubscriptionCount
The number of subscriptions owned by the session.
Public propertySubscriptions
The subscriptions owned by the session.
Protected propertySyncRoot
An object used to synchronize access to the session state.
(Inherited from ClientBase.)
Public propertySystemContext
The system context for use with the session.
Public propertyTransportChannel
Gets or set the channel being wrapped by the client object.
(Inherited from ClientBase.)
Public propertyTypeTree
A cache of the server's type tree.
Protected propertyUseTransportChannel
Gets a value that indicates whether to use the TransportChannel when sending requests.
(Inherited from ClientBase.)

Events

  NameDescription
Public eventKeepAlive
Raised when a keep alive arrives from the server or an error is detected.
Public eventNotification
Raised when a notification message arrives in a publish response.
Public eventPublishError
Raised when an exception occurs while processing a publish response.
Public eventRenewUserIdentity
Occurs before a reconnect operation completes.
Public eventSessionClosing
Raised to indicate the session is closing.
Public eventSubscriptionsChanged
Raised when a subscription is added or removed

See Also