Class ServerEngine

subscribe now with sterfive to access the online-user manual

Hierarchy

EventEmitter
- ServerEngine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServerEngine(options: ServerEngineOptions): ServerEngine

Overrides EventEmitter.constructor
- Defined in node-opcua-server/dist/server_engine.d.ts:62
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

Static Readonly registry

registry: ObjectRegistry

Accessors

buildInfo

get buildInfo(): BuildInfo

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

cumulatedSessionCount

get cumulatedSessionCount(): number

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

Returns number

cumulatedSubscriptionCount

get cumulatedSubscriptionCount(): number

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

Returns number

currentSessionCount

get currentSessionCount(): number

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

Returns number

currentSubscriptionCount

get currentSubscriptionCount(): number

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

Returns number

currentTime

get currentTime(): Date

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

publishingIntervalCount

get publishingIntervalCount(): number

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

rejectedRequestsCount

get rejectedRequestsCount(): number

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

rejectedSessionCount

get rejectedSessionCount(): number

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

serverName

get serverName(): string

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

Returns string

serverNameUrn

get serverNameUrn(): string

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

Returns string

serverNamespaceUrn

get serverNamespaceUrn(): string

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

Returns string

serverStatus

get serverStatus(): ServerStatusDataType

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

sessionAbortCount

get sessionAbortCount(): number

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

sessionTimeoutCount

get sessionTimeoutCount(): number

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

startTime

get startTime(): Date

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

Methods

_createSubscriptionOnSession

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

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

Parameters
- session: ServerSession
- request: CreateSubscriptionRequestOptions
Returns Subscription

browse

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

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

browsePath

browsePath(browsePath: BrowsePath): BrowsePathResult

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

browseSingleNode

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

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

browseSingleNode

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

the browse result

browseWithAutomaticExpansion

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

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

closeSession

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

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

closeSession

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

createSession

createSession(options: CreateSessionOption): ServerSession

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

method

createSession

Parameters
- options: CreateSessionOption
Returns ServerSession

deleteOrphanSubscription

deleteOrphanSubscription(subscription: Subscription): StatusCode

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

dispose

dispose(): void

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

findOrphanSubscription

findOrphanSubscription(subscriptionId: number): Subscription

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

findSubscription

findSubscription(subscriptionId: number): Subscription

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

getOldestUnactivatedSession

getOldestUnactivatedSession(): ServerSession

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

getServerDiagnosticsEnabledFlag

getServerDiagnosticsEnabledFlag(): boolean

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

getSession

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

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

method

getSession

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

historyRead

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

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

historyRead

Parameters
- context: ISessionContext
- 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: ISessionContext, nodeId: NodeId, attributeId: AttributeIds, historyReadDetails: ReadRawModifiedDetails | ReadProcessedDetails | ReadAtTimeDetails | ReadEventDetails, timestampsToReturn: TimestampsToReturn, continuationData: ContinuationData, callback: (err: Error, results?: HistoryReadResult) => void): void

- Defined in node-opcua-server/dist/server_engine.d.ts:217
Parameters
- context: ISessionContext
- nodeId: NodeId
- attributeId: AttributeIds
- historyReadDetails: ReadRawModifiedDetails | ReadProcessedDetails | ReadAtTimeDetails | ReadEventDetails
- timestampsToReturn: TimestampsToReturn
- continuationData: ContinuationData
- 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 node-opcua-server/dist/server_engine.d.ts:100
Returns void

incrementRejectedSessionCount

incrementRejectedSessionCount(): void

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

Returns void

incrementSecurityRejectedRequestsCount

incrementSecurityRejectedRequestsCount(): void

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

incrementSecurityRejectedSessionCount

incrementSecurityRejectedSessionCount(): void

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

Returns void

incrementSessionAbortCount

incrementSessionAbortCount(): void

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

incrementSessionTimeoutCount

incrementSessionTimeoutCount(): void

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

initialize

initialize(options: OPCUAServerOptions, callback: () => void): void

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

initialize

async

Parameters
- options: OPCUAServerOptions
- callback: () => void
  - - (): void
    - Returns void
Returns void

isStarted

isStarted(): boolean

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

read

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

- Defined in node-opcua-server/dist/server_engine.d.ts:191
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: ISessionContext
- readRequest: ReadRequest
Returns DataValue[]

an array of DataValue

readSingleNode

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

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

readSingleNode

Parameters
- context: ISessionContext
- 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 node-opcua-server/dist/server_engine.d.ts:300
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: () => void): void

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

method

registerShutdownTask

Parameters
- task: () => void
  - - (): void
    - Returns void
Returns void

secondsTillShutdown

secondsTillShutdown(): number

- Defined in node-opcua-server/dist/server_engine.d.ts:117
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.

setServerState

setServerState(serverState: ServerState): void

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

setShutdownReason

setShutdownReason(reason: LocalizedTextLike): void

- Defined in node-opcua-server/dist/server_engine.d.ts:111
Parameters
- reason: LocalizedTextLike
Returns void

setShutdownTime

setShutdownTime(date: Date): void

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

shutdown

shutdown(): void

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

shutdown

Returns void

transferSubscription

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

- Defined in node-opcua-server/dist/server_engine.d.ts:272
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: ISessionContext, nodesToWrite: WriteValue[], callback: (err: Error, statusCodes?: StatusCode[]) => void): void

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

method

write

async

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

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

writeSingleNode

async

Parameters
- context: ISessionContext
- writeValue: WriteValue
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

Generated using TypeDoc