ServerSession | NodeOPCUA reference documentation

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.

Hierarchy

EventEmitter
- ServerSession

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ServerSession(parent: ServerEngine, sessionTimeout: number): ServerSession

- Defined in packages/node-opcua-server/dist/server_session.d.ts:71
Parameters
- parent: ServerEngine
- sessionTimeout: number
Returns ServerSession

Properties

__status

__status: string

Optional _watchDog

_watchDog: WatchDog

Optional _watchDogData

_watchDogData: IWatchdogData2

authenticationToken

authenticationToken: NodeId

Optional channel

channel: ServerSecureChannelLayer

Optional channelId

channelId: number

Optional clientDescription

clientDescription: ApplicationDescription

continuationPointManager

continuationPointManager: ContinuationPointManager

Readonly creationDate

creationDate: Date

Optional endpoint

endpoint: EndpointDescription

keepAlive

keepAlive: () => void

Type declaration

- (): void
- Returns void

nodeId

nodeId: NodeId

Optional nonce

nonce: Buffer

sessionName

sessionName: string

sessionObject

sessionObject: any

Optional sessionSecurityDiagnostics

sessionSecurityDiagnostics: UASessionSecurityDiagnostics

sessionTimeout

sessionTimeout: number

Optional subscriptionDiagnosticsArray

subscriptionDiagnosticsArray: UADynamicVariableArray<SubscriptionDiagnosticsDataType>

Optional userIdentityToken

userIdentityToken: UserIdentityToken

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static maxPublishRequestInQueue

maxPublishRequestInQueue: number

Static registry

registry: ObjectRegistry

Accessors

aborted

get aborted(): boolean

- Defined in packages/node-opcua-server/dist/server_session.d.ts:151
true if the underlying channel has been closed or aborted...

Returns boolean

addressSpace

get addressSpace(): AddressSpace

- Defined in packages/node-opcua-server/dist/server_session.d.ts:81
Returns AddressSpace

clientConnectionTime

get clientConnectionTime(): Date

- Defined in packages/node-opcua-server/dist/server_session.d.ts:77
Returns Date

clientLastContactTime

get clientLastContactTime(): number

- Defined in packages/node-opcua-server/dist/server_session.d.ts:78
Returns number

cumulatedSubscriptionCount

get cumulatedSubscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_session.d.ts:109
number of subscriptions ever created since this object is live

Returns number

currentMonitoredItemCount

get currentMonitoredItemCount(): number

- Defined in packages/node-opcua-server/dist/server_session.d.ts:113
number of monitored items

Returns number

currentPublishRequestInQueue

get currentPublishRequestInQueue(): number

- Defined in packages/node-opcua-server/dist/server_session.d.ts:82
Returns number

currentSubscriptionCount

get currentSubscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_session.d.ts:105
number of active subscriptions

Returns number

status

get status(): string
set status(value: string): any

Implementation of IServerSession.status
- Defined in packages/node-opcua-server/dist/server_session.d.ts:79
Returns string
Implementation of IServerSession.status
- Defined in packages/node-opcua-server/dist/server_session.d.ts:80
Parameters
- value: string
Returns any

Methods

_attach_channel

_attach_channel(channel: ServerSecureChannelLayer): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:153
Parameters
- channel: ServerSecureChannelLayer
Returns void

_detach_channel

_detach_channel(): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:154
Returns void

_exposeSubscriptionDiagnostics

_exposeSubscriptionDiagnostics(subscription: Subscription): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:155
Parameters
- subscription: Subscription
Returns void

_unexposeSubscriptionDiagnostics

_unexposeSubscriptionDiagnostics(subscription: Subscription): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:156
Parameters
- subscription: Subscription
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

close

close(deleteSubscriptions: boolean, reason: string): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:144
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.

method

close

Parameters
- deleteSubscriptions: boolean
  
  : should we delete subscription ?
- reason: string
Returns void

createSubscription

createSubscription(parameters: CreateSubscriptionRequestOptions): Subscription

- Defined in packages/node-opcua-server/dist/server_session.d.ts:152
Parameters
- parameters: CreateSubscriptionRequestOptions
Returns Subscription

deleteSubscription

deleteSubscription(subscriptionId: number): StatusCode

- Defined in packages/node-opcua-server/dist/server_session.d.ts:126
method

deleteSubscription

Parameters
- subscriptionId: number
Returns StatusCode

dispose

dispose(): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:76
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getEndpointDescription

getEndpointDescription(): EndpointDescription

- Defined in packages/node-opcua-server/dist/server_session.d.ts:75
Returns EndpointDescription

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getSessionDiagnosticsArray

getSessionDiagnosticsArray(): UADynamicVariableArray<SessionDiagnosticsDataType>

- Defined in packages/node-opcua-server/dist/server_session.d.ts:97
returns rootFolder.objects.server.serverDiagnostics.sessionsDiagnosticsSummary.sessionDiagnosticsArray

Returns UADynamicVariableArray<SessionDiagnosticsDataType>

getSessionId

getSessionId(): NodeId

Implementation of ISessionBase.getSessionId
- Defined in packages/node-opcua-server/dist/server_session.d.ts:73
Returns NodeId

getSessionSecurityDiagnosticsArray

getSessionSecurityDiagnosticsArray(): UADynamicVariableArray<SessionSecurityDiagnosticsDataType>

- Defined in packages/node-opcua-server/dist/server_session.d.ts:101
returns rootFolder.objects.server.serverDiagnostics.sessionsDiagnosticsSummary.sessionSecurityDiagnosticsArray

Returns UADynamicVariableArray<SessionSecurityDiagnosticsDataType>

getSubscription

getSubscription(subscriptionId: number): Subscription

- Defined in packages/node-opcua-server/dist/server_session.d.ts:120
retrieve an existing subscription by subscriptionId

method

getSubscription

Parameters
- subscriptionId: number
Returns Subscription

incrementRequestErrorCounter

incrementRequestErrorCounter(counterName: string): void

Implementation of IServerSession.incrementRequestErrorCounter
- Defined in packages/node-opcua-server/dist/server_session.d.ts:93
Parameters
- counterName: string
Returns void

incrementRequestTotalCounter

incrementRequestTotalCounter(counterName: string): void

Implementation of IServerSession.incrementRequestTotalCounter
- Defined in packages/node-opcua-server/dist/server_session.d.ts:92
Parameters
- counterName: string
Returns void

incrementTotalRequestCount

incrementTotalRequestCount(): void

Implementation of IServerSession.incrementTotalRequestCount
- Defined in packages/node-opcua-server/dist/server_session.d.ts:91
Returns void

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

on

on(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

once

once(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

registerNode

registerNode(nodeId: NodeId): any

- Defined in packages/node-opcua-server/dist/server_session.d.ts:145
Parameters
- nodeId: NodeId
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): ServerSession

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ServerSession

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ServerSession

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSession

resolveRegisteredNode

resolveRegisteredNode(aliasNodeId: NodeId): NodeId

- Defined in packages/node-opcua-server/dist/server_session.d.ts:147
Parameters
- aliasNodeId: NodeId
Returns NodeId

setMaxListeners

setMaxListeners(n: number): ServerSession

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ServerSession

unRegisterNode

unRegisterNode(aliasNodeId: NodeId): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:146
Parameters
- aliasNodeId: NodeId
Returns void

updateClientLastContactTime

updateClientLastContactTime(): void

- Defined in packages/node-opcua-server/dist/server_session.d.ts:83
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

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

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Static maxPublishRequestInQueue

Static registry

Accessors

aborted

Returns boolean

addressSpace

Returns AddressSpace

clientConnectionTime

Returns Date

clientLastContactTime

Returns number

cumulatedSubscriptionCount

Returns number

currentMonitoredItemCount

Returns number

currentPublishRequestInQueue

Returns number

currentSubscriptionCount

Returns number

status

Returns string

Parameters

value: string

Returns any

Methods

_attach_channel

Parameters

channel: ServerSecureChannelLayer

Returns void

_detach_channel

Returns void

_exposeSubscriptionDiagnostics

Parameters

subscription: Subscription

Returns void

_unexposeSubscriptionDiagnostics

Parameters