Hierarchy
-
EventEmitter
- ServerSession
Implements
Index
Constructors
Properties
- __status
- _watch
Dog - _watch
Dog Data - authentication
Token - channel
- channel
Id - client
Description - continuation
Point Manager - creation
Date - endpoint
- keep
Alive - node
Id - nonce
- parent
- publish
Engine - session
Diagnostics - session
Name - session
Object - session
Security Diagnostics - session
Timeout - subscription
Diagnostics Array - user
Identity Token - max
Publish Request InQueue - registry
Accessors
Methods
- _attach_
channel - _detach_
channel - _expose
Subscription Diagnostics - _unexpose
Subscription Diagnostics - close
- create
Subscription - delete
Subscription - dispose
- get
Endpoint Description - get
Session Diagnostics Array - get
Session Id - get
Session Security Diagnostics Array - get
Subscription - increment
Request Error Counter - increment
Request Total Counter - increment
Total Request Count - register
Node - resolve
Registered Node - un
Register Node - update
Client Last Contact Time
Constructors
constructor
-
Parameters
-
parent: ServerEngine
-
sessionTimeout: number
Returns ServerSession
-
Properties
__status
Optional _watchDog
Optional _watchDogData
authenticationToken
Optional channel
Optional channelId
Optional clientDescription
continuationPointManager
Readonly creationDate
Optional endpoint
keepAlive
Type declaration
-
-
Returns void
-
nodeId
Optional nonce
parent
publishEngine
Optional sessionDiagnostics
sessionName
sessionObject
Optional sessionSecurityDiagnostics
sessionTimeout
Optional subscriptionDiagnosticsArray
Optional userIdentityToken
Static maxPublishRequestInQueue
Static registry
Accessors
aborted
-
true if the underlying channel has been closed or aborted...
Returns boolean
addressSpace
-
Returns AddressSpace
clientConnectionTime
-
Returns Date
clientLastContactTime
-
return the number of milisecond since last session transaction occurs from client the first transaction is the creation of the session
Returns number
cumulatedSubscriptionCount
-
number of subscriptions ever created since this object is live
Returns number
currentMonitoredItemCount
-
number of monitored items
Returns number
currentPublishRequestInQueue
-
Returns number
currentSubscriptionCount
-
number of active subscriptions
Returns number
status
-
Returns string
-
Parameters
-
value: string
Returns void
-
Methods
_attach_channel
-
Parameters
-
channel: ServerSecureChannelLayer
Returns void
-
_detach_channel
-
Returns void
_exposeSubscriptionDiagnostics
-
Parameters
-
subscription: Subscription
Returns void
-
_unexposeSubscriptionDiagnostics
-
Parameters
-
subscription: Subscription
Returns void
-
close
-
close a ServerSession, this will also delete the subscriptions if the flag is set.
Spec extract:
If a Client invokes the CloseSession Service then all Subscriptions associated with the Session are also deleted if the deleteSubscriptions flag is set to TRUE. If a Server terminates a Session for any other reason, Subscriptions associated with the Session, are not deleted. Each Subscription has its own lifetime to protect against data loss in the case of a Session termination. In these cases, the Subscription can be reassigned to another Client before its lifetime expires.
Parameters
-
deleteSubscriptions: boolean
: should we delete subscription ?
-
reason: string
Returns void
-
createSubscription
-
Parameters
-
parameters: CreateSubscriptionRequestOptions
Returns Subscription
-
deleteSubscription
-
Parameters
-
subscriptionId: number
Returns StatusCode
-
dispose
-
Returns void
getEndpointDescription
-
Returns EndpointDescription
getSessionDiagnosticsArray
-
returns rootFolder.objects.server.serverDiagnostics.sessionsDiagnosticsSummary.sessionDiagnosticsArray
Returns UADynamicVariableArray<SessionDiagnosticsDataType>
getSessionId
-
Returns NodeId
getSessionSecurityDiagnosticsArray
-
returns rootFolder.objects.server.serverDiagnostics.sessionsDiagnosticsSummary.sessionSecurityDiagnosticsArray
Returns UADynamicVariableArray<SessionSecurityDiagnosticsDataType>
getSubscription
-
retrieve an existing subscription by subscriptionId
Parameters
-
subscriptionId: number
Returns Subscription
-
incrementRequestErrorCounter
-
Parameters
-
counterName: string
Returns void
-
incrementRequestTotalCounter
-
Parameters
-
counterName: string
Returns void
-
incrementTotalRequestCount
-
Returns void
registerNode
resolveRegisteredNode
unRegisterNode
-
Parameters
-
aliasNodeId: NodeId
Returns void
-
updateClientLastContactTime
-
Returns void
A Server session object.
from OPCUA Spec 1.02:
Sessions are created to be independent of the underlying communications connection. Therefore, if a communication connection fails, the Session is not immediately affected. The exact mechanism to recover from an underlying communication connection error depends on the SecureChannel mapping as described in Part 6.
Sessions are terminated by the Server automatically if the Client fails to issue a Service request on the Session within the timeout period negotiated by the Server in the CreateSession Service response. This protects the Server against Client failures and against situations where a failed underlying connection cannot be re-established.
Clients shall be prepared to submit requests in a timely manner to prevent the Session from closing automatically.
Clients may explicitly terminate Sessions using the CloseSession Service.
When a Session is terminated, all outstanding requests on the Session are aborted and BadSessionClosed StatusCodes are returned to the Client. In addition, the Server deletes the entry for the Client from its SessionDiagnosticsArray Variable and notifies any other Clients who were subscribed to this entry.