node-opcua-server | NodeOPCUA reference documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Events

RegisterServerManager

Type aliases

ClosingReason

ClosingReason: "Timeout" | "Terminated" | "CloseSession" | "Forcing"

Counter

Counter: number

CreateMonitoredItemHook

CreateMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

- (subscription: Subscription, monitoredItem: MonitoredItemBase): Promise<StatusCode>
- Parameters
  - subscription: Subscription
  - monitoredItem: MonitoredItemBase
  Returns Promise<StatusCode>

DeleteMonitoredItemHook

DeleteMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

- (subscription: Subscription, monitoredItem: MonitoredItemBase): Promise<StatusCode>
- Parameters
  - subscription: Subscription
  - monitoredItem: MonitoredItemBase
  Returns Promise<StatusCode>

Notification

Notification: DataChangeNotification | EventNotificationList | StatusChangeNotification

QueueItem

QueueItem: MonitoredItemNotification | EventFieldList

StringGetter

StringGetter: () => string

Type declaration

- (): string
- Returns string

ValidUserAsyncFunc

ValidUserAsyncFunc: (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void) => void

Type declaration

- (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void): void
- Parameters
  - this: ServerSession
  - username: string
  - password: string
  - callback: (err: Error | null, isAuthorized?: boolean) => void
    - - (err: Error | null, isAuthorized?: boolean): void
      - Parameters
        
        err: Error | null
        
        Optional isAuthorized: boolean
        
        Returns void
  Returns void

ValidUserFunc

ValidUserFunc: (this: ServerSession, username: string, password: string) => boolean

Type declaration

- (this: ServerSession, username: string, password: string): boolean
- Parameters
  - this: ServerSession
  - username: string
  - password: string
  Returns boolean

Events

RegisterServerManager

RegisterServerManager:

RegisterServerManager is responsible to Register an opcua server on a LDS or LDS-ME server This class takes in charge :

the initial registration of a server
the regular registration renewal (every 8 minutes or so ...)
dealing with cases where LDS is not up and running when server starts. ( in this case the connection will be continuously attempted using the infinite back-off strategy
the un-registration of the server ( during shutdown for instance)

Events:

Emitted when the server is trying to registered the LDS but when the connection to the lds has failed serverRegistrationPending is sent when the backoff signal of the connection process is rained

param
param
param

constructor

new RegisterServerManager(options: RegisterServerManagerOptions): RegisterServerManager

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:76
Parameters
- options: RegisterServerManagerOptions
Returns RegisterServerManager

discoveryServerEndpointUrl

discoveryServerEndpointUrl: string

timeout

timeout: number

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.

_emitEvent

_emitEvent(eventName: string): void

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:79
Parameters
- eventName: string
Returns void

_establish_initial_connection

_establish_initial_connection(outer_callback: ErrorCallback): void

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:82
Parameters
- outer_callback: ErrorCallback
Returns void

_setState

_setState(status: RegisterServerManagerStatus): void

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:80
Parameters
- status: RegisterServerManagerStatus
Returns void

_trigger_next

_trigger_next(): void

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

addListener

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

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

dispose

dispose(): void

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

getMaxListeners

getMaxListeners(): number

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

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

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

on

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

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

once

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

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

prependListener

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

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

prependOnceListener

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

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

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): RegisterServerManager

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

removeListener

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

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

setMaxListeners

setMaxListeners(n: number): RegisterServerManager

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

start

start(callback: ErrorCallback): void

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:81
Parameters
- callback: ErrorCallback
Returns void

stop

stop(outer_callback: ErrorCallback): void

- Defined in packages/node-opcua-server/dist/register_server_manager.d.ts:84
Parameters
- outer_callback: ErrorCallback
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

Index

Enumerations

Classes

Interfaces

Type aliases

Events

Type aliases

ClosingReason

Counter

CreateMonitoredItemHook

Type declaration

Parameters

subscription: Subscription

monitoredItem: MonitoredItemBase

Returns Promise<StatusCode>

DeleteMonitoredItemHook

Type declaration

Parameters

subscription: Subscription

monitoredItem: MonitoredItemBase

Returns Promise<StatusCode>

Notification

QueueItem

StringGetter

Type declaration

Returns string

ValidUserAsyncFunc

Type declaration

Parameters

this: ServerSession

username: string

password: string

callback: (err: Error | null, isAuthorized?: boolean) => void

Parameters

err: Error | null

Optional isAuthorized: boolean

Returns void

Returns void

ValidUserFunc

Type declaration

Parameters

this: ServerSession

username: string

password: string

Returns boolean

Events

RegisterServerManager

constructor

Parameters

options: RegisterServerManagerOptions

Returns RegisterServerManager

discoveryServerEndpointUrl

timeout

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

_emitEvent

Parameters

eventName: string

Returns void

_establish_initial_connection

Parameters

outer_callback: ErrorCallback

Returns void

_setState

Parameters

status: RegisterServerManagerStatus

Returns void

_trigger_next

Returns void

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns RegisterServerManager