Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServerEngine

Hierarchy

  • EventEmitter
    • ServerEngine

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_internalState

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

addressSpace

addressSpace: AddressSpace | null

Optional clientDescription

clientDescription: ApplicationDescription

historyServerCapabilities

historyServerCapabilities: HistoryServerCapabilities

isAuditing

isAuditing: boolean

serverCapabilities

serverCapabilities: ServerCapabilities

serverDiagnosticsEnabled

serverDiagnosticsEnabled: boolean

serverDiagnosticsSummary

serverDiagnosticsSummary: ServerDiagnosticsSummaryDataType

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

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 Readonly registry

registry: ObjectRegistry = new ObjectRegistry()

Accessors

buildInfo

  • get buildInfo(): BuildInfo

  • Returns BuildInfo

cumulatedSessionCount

  • get cumulatedSessionCount(): number

  • the cumulated number of sessions that have been opened since this object exists

    Returns number

cumulatedSubscriptionCount

  • get cumulatedSubscriptionCount(): number

  • the cumulated number of subscriptions that have been created since this object exists

    Returns number

currentSessionCount

  • get currentSessionCount(): number

  • the number of active sessions

    Returns number

currentSubscriptionCount

  • get currentSubscriptionCount(): number

  • the number of active subscriptions.

    Returns number

currentTime

  • get currentTime(): Date

  • Returns Date

publishingIntervalCount

  • get publishingIntervalCount(): number

  • Returns number

rejectedRequestsCount

  • get rejectedRequestsCount(): number

  • Returns number

rejectedSessionCount

  • get rejectedSessionCount(): number

  • Returns number

serverName

  • get serverName(): string

  • the name of the server

    Returns string

serverNameUrn

  • get serverNameUrn(): string

  • the server urn

    Returns string

serverNamespaceUrn

  • get serverNamespaceUrn(): string

  • the urn of the server namespace

    Returns string

serverStatus

  • get serverStatus(): ServerStatusDataType

  • Returns ServerStatusDataType

sessionAbortCount

  • get sessionAbortCount(): number

  • Returns number

sessionTimeoutCount

  • get sessionTimeoutCount(): number

  • Returns number

startTime

  • get startTime(): Date

  • Returns Date

Methods

_createSubscriptionOnSession

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

browse

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

  • Parameters

    • nodesToBrowse: BrowseDescription[]
    • Optional context: SessionContext

    Returns BrowseResult[]

browsePath

  • browsePath(browsePath: BrowsePath): BrowsePathResult

  • Parameters

    • browsePath: BrowsePath

    Returns BrowsePathResult

browseSingleNode

  • browseSingleNode(nodeId: NodeIdLike, browseDescription: BrowseDescription, context?: SessionContext): BrowseResult
  • 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[]>

  • Parameters

    • nodesToBrowse: BrowseDescription[]
    • Optional context: SessionContext

    Returns Promise<BrowseResult[]>

closeSession

  • closeSession(authenticationToken: NodeId, deleteSubscriptions: boolean, reason: "Timeout" | "Terminated" | "CloseSession" | "Forcing"): void
  • method

    closeSession

    Parameters

    • authenticationToken: NodeId
    • deleteSubscriptions: boolean

      : true if sessions's subscription shall be deleted

    • reason: "Timeout" | "Terminated" | "CloseSession" | "Forcing"

    Returns void

createSession

  • create a new server session object.

    method

    createSession

    Parameters

    Returns ServerSession

deleteOrphanSubscription

  • deleteOrphanSubscription(subscription: Subscription): StatusCode

  • Parameters

    Returns StatusCode

dispose

  • dispose(): void

  • Returns void

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

findOrphanSubscription

  • findOrphanSubscription(subscriptionId: number): Subscription | null

  • Parameters

    • subscriptionId: number

    Returns Subscription | null

findSubscription

  • findSubscription(subscriptionId: number): Subscription | null

  • Parameters

    • subscriptionId: number

    Returns Subscription | null

getMaxListeners

  • getMaxListeners(): number

getOldestUnactivatedSession

  • Returns ServerSession | null

getServerDiagnosticsEnabledFlag

  • getServerDiagnosticsEnabledFlag(): boolean

  • Returns boolean

getSession

  • getSession(authenticationToken: NodeId, activeOnly?: boolean): ServerSession | null

  • retrieve a session by its authenticationToken.

    method

    getSession

    Parameters

    • authenticationToken: NodeId
    • Optional activeOnly: boolean

    Returns ServerSession | null

historyRead

  • historyRead(context: SessionContext, historyReadRequest: HistoryReadRequest, callback: function): void
  • method

    historyRead

    Parameters

    • context: SessionContext
    • historyReadRequest: HistoryReadRequest
    • callback: function
        • (err: Error | null, results: HistoryReadResult[]): void

        • Parameters

          • err: Error | null
          • results: HistoryReadResult[]

          Returns void

    Returns void

historyReadSingleNode

  • historyReadSingleNode(context: SessionContext, nodeId: NodeId, attributeId: AttributeIds, historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, timestampsToReturn: TimestampsToReturn, callback: function): void

  • Parameters

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

        • Parameters

          • err: Error | null
          • Optional results: HistoryReadResult

          Returns void

    Returns void

incrementRejectedRequestsCount

  • incrementRejectedRequestsCount(): void

  • Returns void

incrementRejectedSessionCount

  • incrementRejectedSessionCount(): void

  • increment rejected session count (also increment rejected requests count)

    Returns void

incrementSecurityRejectedRequestsCount

  • incrementSecurityRejectedRequestsCount(): void

  • Returns void

incrementSecurityRejectedSessionCount

  • incrementSecurityRejectedSessionCount(): void

  • increment rejected session count (also increment rejected requests count)

    Returns void

incrementSessionAbortCount

  • incrementSessionAbortCount(): void

  • Returns void

incrementSessionTimeoutCount

  • incrementSessionTimeoutCount(): void

  • Returns void

initialize

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

    initialize

    async

    Parameters

    • options: any
    • callback: any

    Returns void

isStarted

  • isStarted(): boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

read

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

  • 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

  • method

    readSingleNode

    Parameters

    Returns DataValue

    DataValue

refreshValues

  • refreshValues(nodesToRefresh: ReadValueId[] | HistoryReadValueId[], maxAge: number, callback: function): void

  • 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: function
        • (err: Error | null, dataValues?: DataValue[]): void

        • Parameters

          • err: Error | null
          • Optional dataValues: DataValue[]

          Returns void

    Returns void

registerShutdownTask

  • registerShutdownTask(task: any): void

  • 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): this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

secondsTillShutdown

  • secondsTillShutdown(): number
  • 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): this

setServerState

  • Parameters

    Returns void

setShutdownReason

  • Parameters

    Returns void

setShutdownTime

  • setShutdownTime(date: Date): void

  • Parameters

    Returns void

shutdown

  • shutdown(): void
  • method

    shutdown

    Returns void

transferSubscription

  • transferSubscription(session: ServerSession, subscriptionId: number, sendInitialValues: boolean): Promise<TransferResult>
  • 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: function): void

  • write a collection of nodes

    method

    write

    async

    Parameters

    • context: SessionContext
    • nodesToWrite: WriteValue[]
    • callback: function
        • (err: Error | null, statusCodes?: StatusCode[]): void

        • Parameters

          • err: Error | null
          • Optional statusCodes: StatusCode[]

          Returns void

    Returns void

writeSingleNode

  • writeSingleNode(context: SessionContext, writeValue: WriteValue, callback: function): void
  • method

    writeSingleNode

    async

    Parameters

    • context: SessionContext
    • writeValue: WriteValue
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void

        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc