ServerEngine | NodeOPCUA reference documentation

Hierarchy

EventEmitter
- ServerEngine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServerEngine(options: ServerEngineOptions): ServerEngine

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:57
Parameters
- options: ServerEngineOptions
Returns ServerEngine

Properties

_internalState

_internalState: "initialized" | "creating" | "initializing" | "shutdown" | "disposed"

addressSpace

addressSpace: AddressSpace

Optional clientDescription

clientDescription: ApplicationDescription

historyServerCapabilities

historyServerCapabilities: HistoryServerCapabilities

isAuditing

isAuditing: boolean

serverCapabilities

serverCapabilities: ServerCapabilities

serverDiagnosticsEnabled

serverDiagnosticsEnabled: boolean

serverDiagnosticsSummary

serverDiagnosticsSummary: ServerDiagnosticsSummaryDataType

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.

Readonly Static registry

registry: ObjectRegistry

Accessors

buildInfo

get buildInfo(): BuildInfo

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:63
Returns BuildInfo

cumulatedSessionCount

get cumulatedSessionCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:80
the cumulated number of sessions that have been opened since this object exists

Returns number

cumulatedSubscriptionCount

get cumulatedSubscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:88
the cumulated number of subscriptions that have been created since this object exists

Returns number

currentSessionCount

get currentSessionCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:76
the number of active sessions

Returns number

currentSubscriptionCount

get currentSubscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:84
the number of active subscriptions.

Returns number

currentTime

get currentTime(): Date

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:62
Returns Date

publishingIntervalCount

get publishingIntervalCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:93
Returns number

rejectedRequestsCount

get rejectedRequestsCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:90
Returns number

rejectedSessionCount

get rejectedSessionCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:89
Returns number

serverName

get serverName(): string

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:117
the name of the server

Returns string

serverNameUrn

get serverNameUrn(): string

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:121
the server urn

Returns string

serverNamespaceUrn

get serverNamespaceUrn(): string

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:125
the urn of the server namespace

Returns string

serverStatus

get serverStatus(): ServerStatusDataType

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:126
Returns ServerStatusDataType

sessionAbortCount

get sessionAbortCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:91
Returns number

sessionTimeoutCount

get sessionTimeoutCount(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:92
Returns number

startTime

get startTime(): Date

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:61
Returns Date

Methods

_createSubscriptionOnSession

_createSubscriptionOnSession(session: ServerSession, request: CreateSubscriptionRequestOptions): Subscription

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:303
create a new subscription

Parameters
- session: ServerSession
- request: CreateSubscriptionRequestOptions
Returns Subscription

addListener

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

- 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 ServerEngine

browse

browse(nodesToBrowse: BrowseDescription[], context?: SessionContext): BrowseResult[]

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:153
Parameters
- nodesToBrowse: BrowseDescription[]
- Optional context: SessionContext
Returns BrowseResult[]

browsePath

browsePath(browsePath: BrowsePath): BrowsePathResult

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:280
Parameters
- browsePath: BrowsePath
Returns BrowsePathResult

browseSingleNode

browseSingleNode(nodeId: NodeIdLike, browseDescription: BrowseDescription, context?: SessionContext): BrowseResult

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:148
method

browseSingleNode

Parameters
- nodeId: NodeIdLike
  
  : the nodeid of the element to browse
- browseDescription: BrowseDescription
- Optional context: SessionContext
Returns BrowseResult

the browse result

browseWithAutomaticExpansion

browseWithAutomaticExpansion(nodesToBrowse: BrowseDescription[], context?: SessionContext): Promise<BrowseResult[]>

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:149
Parameters
- nodesToBrowse: BrowseDescription[]
- Optional context: SessionContext
Returns Promise<BrowseResult[]>

closeSession

closeSession(authenticationToken: NodeId, deleteSubscriptions: boolean, reason: ClosingReason): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:257
method

closeSession

Parameters
- authenticationToken: NodeId
- deleteSubscriptions: boolean
  
  : true if sessions's subscription shall be deleted
- reason: ClosingReason
Returns void

createSession

createSession(options: CreateSessionOption): ServerSession

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:239
create a new server session object.

method

createSession

Parameters
- options: CreateSessionOption
Returns ServerSession

deleteOrphanSubscription

deleteOrphanSubscription(subscription: Subscription): StatusCode

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:260
Parameters
- subscription: Subscription
Returns StatusCode

dispose

dispose(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:60
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)[]

findOrphanSubscription

findOrphanSubscription(subscriptionId: number): Subscription

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:259
Parameters
- subscriptionId: number
Returns Subscription

findSubscription

findSubscription(subscriptionId: number): Subscription

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:258
Parameters
- subscriptionId: number
Returns Subscription

getMaxListeners

getMaxListeners(): number

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

getOldestUnactivatedSession

getOldestUnactivatedSession(): ServerSession

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:229
Returns ServerSession

getServerDiagnosticsEnabledFlag

getServerDiagnosticsEnabledFlag(): boolean

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:128
Returns boolean

getSession

getSession(authenticationToken: NodeId, activeOnly?: boolean): ServerSession

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:277
retrieve a session by its authenticationToken.

method

getSession

Parameters
- authenticationToken: NodeId
- Optional activeOnly: boolean
Returns ServerSession

historyRead

historyRead(context: SessionContext, historyReadRequest: HistoryReadRequest, callback: (err: Error, results: HistoryReadResult[]) => void): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:228
method

historyRead

Parameters
- context: SessionContext
- historyReadRequest: HistoryReadRequest
- callback: (err: Error, results: HistoryReadResult[]) => void
  - - (err: Error, results: HistoryReadResult[]): void
    - Parameters
      - err: Error
      - results: HistoryReadResult[]
      Returns void
Returns void

historyReadSingleNode

historyReadSingleNode(context: SessionContext, nodeId: NodeId, attributeId: AttributeIds, historyReadDetails: ReadRawModifiedDetails | ReadProcessedDetails | ReadAtTimeDetails | ReadEventDetails, timestampsToReturn: TimestampsToReturn, callback: (err: Error, results?: HistoryReadResult) => void): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:213
Parameters
- context: SessionContext
- nodeId: NodeId
- attributeId: AttributeIds
- historyReadDetails: ReadRawModifiedDetails | ReadProcessedDetails | ReadAtTimeDetails | ReadEventDetails
- timestampsToReturn: TimestampsToReturn
- callback: (err: Error, results?: HistoryReadResult) => void
  - - (err: Error, results?: HistoryReadResult): void
    - Parameters
      - err: Error
      - Optional results: HistoryReadResult
      Returns void
Returns void

incrementRejectedRequestsCount

incrementRejectedRequestsCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:96
Returns void

incrementRejectedSessionCount

incrementRejectedSessionCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:100
increment rejected session count (also increment rejected requests count)

Returns void

incrementSecurityRejectedRequestsCount

incrementSecurityRejectedRequestsCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:101
Returns void

incrementSecurityRejectedSessionCount

incrementSecurityRejectedSessionCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:105
increment rejected session count (also increment rejected requests count)

Returns void

incrementSessionAbortCount

incrementSessionAbortCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:95
Returns void

incrementSessionTimeoutCount

incrementSessionTimeoutCount(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:94
Returns void

initialize

initialize(options: any, callback: any): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:137
method

initialize

async

Parameters
- options: any
- callback: any
Returns void

isStarted

isStarted(): boolean

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:59
Returns boolean

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): ServerEngine

- 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 ServerEngine

on

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

- 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 ServerEngine

once

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

- 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 ServerEngine

prependListener

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

- 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 ServerEngine

prependOnceListener

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

- 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 ServerEngine

rawListeners

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

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

read

read(context: SessionContext, readRequest: ReadRequest): DataValue[]

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:187
Maximum age of the value to be read in milliseconds. The age of the value is based on the difference between the ServerTimestamp and the time when the Server starts processing the request. For example if the Client specifies a maxAge of 500 milliseconds and it takes 100 milliseconds until the Server starts processing the request, the age of the returned value could be 600 milliseconds prior to the time it was requested. If the Server has one or more values of an Attribute that are within the maximum age, it can return any one of the values or it can read a new value from the data source. The number of values of an Attribute that a Server has depends on the number of MonitoredItems that are defined for the Attribute. In any case, the Client can make no assumption about which copy of the data will be returned. If the Server does not have a value that is within the maximum age, it shall attempt to read a new value from the data source. If the Server cannot meet the requested maxAge, it returns its 'best effort' value rather than rejecting the request. This may occur when the time it takes the Server to process and return the new data value after it has been accessed is greater than the specified maximum age. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to get a cached value. Negative values are invalid for maxAge.

Parameters
- context: SessionContext
- readRequest: ReadRequest
Returns DataValue[]

an array of DataValue

readSingleNode

readSingleNode(context: SessionContext, nodeId: string | NodeId, attributeId: AttributeIds, timestampsToReturn?: TimestampsToReturn): DataValue

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:163
method

readSingleNode

Parameters
- context: SessionContext
- nodeId: string | NodeId
- attributeId: AttributeIds
- Optional timestampsToReturn: TimestampsToReturn
Returns DataValue

DataValue

refreshValues

refreshValues(nodesToRefresh: ReadValueId[] | HistoryReadValueId[], maxAge: number, callback: (err: Error, dataValues?: DataValue[]) => void): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:296
performs a call to asyncRefresh on all variable nodes that provide an async refresh func.

method

refreshValues

async

Parameters
- nodesToRefresh: ReadValueId[] | HistoryReadValueId[]
  
  an array containing the node to consider Each element of the array shall be of the form { nodeId: , attributeIds: }.
- maxAge: number
- callback: (err: Error, dataValues?: DataValue[]) => void
  - - (err: Error, dataValues?: DataValue[]): void
    - Parameters
      - err: Error
      - Optional dataValues: DataValue[]
      Returns void
Returns void

registerShutdownTask

registerShutdownTask(task: any): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:68
register a function that will be called when the server will perform its shut down.

method

registerShutdownTask

Parameters
- task: any
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): ServerEngine

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

removeListener

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

- 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 ServerEngine

secondsTillShutdown

secondsTillShutdown(): number

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:113
method

secondsTillShutdown

Returns number

the approximate number of seconds until the server will be shut down. The value is only relevant once the state changes into SHUTDOWN.

setMaxListeners

setMaxListeners(n: number): ServerEngine

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

setServerState

setServerState(serverState: ServerState): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:127
Parameters
- serverState: ServerState
Returns void

setShutdownReason

setShutdownReason(reason: string | LocalizedTextOptions): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:107
Parameters
- reason: string | LocalizedTextOptions
Returns void

setShutdownTime

setShutdownTime(date: Date): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:106
Parameters
- date: Date
Returns void

shutdown

shutdown(): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:72
method

shutdown

Returns void

transferSubscription

transferSubscription(session: ServerSession, subscriptionId: number, sendInitialValues: boolean): Promise<TransferResult>

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:268
method

transferSubscription

Parameters
- session: ServerSession
  
  the new session that will own the subscription
- subscriptionId: number
  
  the subscription Id to transfer
- sendInitialValues: boolean
  
  true if initial values will be resent.
Returns Promise<TransferResult>

write

write(context: SessionContext, nodesToWrite: WriteValue[], callback: (err: Error, statusCodes?: StatusCode[]) => void): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:209
write a collection of nodes

method

write

async

Parameters
- context: SessionContext
- nodesToWrite: WriteValue[]
- callback: (err: Error, statusCodes?: StatusCode[]) => void
  - - (err: Error, statusCodes?: StatusCode[]): void
    - Parameters
      - err: Error
      - Optional statusCodes: StatusCode[]
      Returns void
Returns void

writeSingleNode

writeSingleNode(context: SessionContext, writeValue: WriteValue, callback: (err: Error, statusCode?: StatusCode) => void): void

- Defined in packages/node-opcua-server/dist/server_engine.d.ts:198
method

writeSingleNode

async

Parameters
- context: SessionContext
- writeValue: WriteValue
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ServerEngineOptions

Returns ServerEngine

Properties

_internalState

addressSpace

Optional clientDescription

historyServerCapabilities

isAuditing

serverCapabilities

serverDiagnosticsEnabled

serverDiagnosticsSummary

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Readonly Static registry

Accessors

buildInfo

Returns BuildInfo

cumulatedSessionCount

Returns number

cumulatedSubscriptionCount

Returns number

currentSessionCount

Returns number

currentSubscriptionCount

Returns number

currentTime

Returns Date

publishingIntervalCount

Returns number

rejectedRequestsCount

Returns number

rejectedSessionCount

Returns number

serverName

Returns string

serverNameUrn

Returns string

serverNamespaceUrn

Returns string

serverStatus

Returns ServerStatusDataType

sessionAbortCount

Returns number

sessionTimeoutCount

Returns number

startTime

Returns Date

Methods

_createSubscriptionOnSession

Parameters

session: ServerSession

request: CreateSubscriptionRequestOptions

Returns Subscription

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ServerEngine

browse

Parameters

nodesToBrowse: BrowseDescription[]

Optional context: SessionContext

Returns BrowseResult[]

browsePath

Parameters