OPCUABaseServer | NodeOPCUA reference documentation

Hierarchy

OPCUASecureObject
- OPCUABaseServer
  - OPCUAServer
  - OPCUAServer

Index

Constructors

constructor

Properties

Accessors

serverType

Constructors

constructor

new OPCUABaseServer(options?: OPCUABaseServerOptions): OPCUABaseServer

Inherited from OPCUASecureObject.constructor
- Defined in packages/node-opcua-server/source/base_server.ts:132
Parameters
- Optional options: OPCUABaseServerOptions
Returns OPCUABaseServer

Properties

capabilitiesForMDNS

capabilitiesForMDNS: string[]

Readonly certificateFile

certificateFile: string

endpoints

endpoints: OPCUAServerEndPoint[]

Readonly privateKeyFile

privateKeyFile: string

Readonly serverCertificateManager

serverCertificateManager: OPCUACertificateManager

serverInfo

serverInfo: ApplicationDescription

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 makeServiceFault

makeServiceFault: (statusCode: StatusCode, messages: string[]) => ServiceFault = ...

Type declaration

- (statusCode: StatusCode, messages: string[]): ServiceFault
- construct a service Fault response
  
  method
  
  makeServiceFault
  
  Parameters
  - statusCode: StatusCode
  - messages: string[]
  Returns ServiceFault

Accessors

serverType

get serverType(): ApplicationType

- Defined in packages/node-opcua-server/source/base_server.ts:122
The type of server

Returns ApplicationType

Methods

addListener

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

Inherited from OPCUASecureObject.addListener
- 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 OPCUABaseServer

emit

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

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

eventNames

eventNames(): (string | symbol)[]

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

getCertificate

getCertificate(): Buffer

Inherited from OPCUASecureObject.getCertificate
- Defined in packages/node-opcua-common/dist/opcua_secure_object.d.ts:28
Returns Buffer

getCertificateChain

getCertificateChain(): Buffer

Inherited from OPCUASecureObject.getCertificateChain
- Defined in packages/node-opcua-common/dist/opcua_secure_object.d.ts:29
Returns Buffer

getDiscoveryUrls

getDiscoveryUrls(): string[]

- Defined in packages/node-opcua-server/source/base_server.ts:410
Returns string[]

getEndpointUrl

getEndpointUrl(): string

- Defined in packages/node-opcua-server/source/base_server.ts:406
get one of the possible endpointUrl

Returns string

getMaxListeners

getMaxListeners(): number

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

getPrivateKey

getPrivateKey(): string

Inherited from OPCUASecureObject.getPrivateKey
- Defined in packages/node-opcua-common/dist/opcua_secure_object.d.ts:30
Returns string

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

- Defined in packages/node-opcua-server/source/base_server.ts:417
Parameters
- channel: ServerSecureChannelLayer
Returns ApplicationDescription[]

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

Inherited from OPCUASecureObject.listeners
- 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): OPCUABaseServer

Inherited from OPCUASecureObject.off
- 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 OPCUABaseServer

on

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

Inherited from OPCUASecureObject.on
- 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 OPCUABaseServer

once

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

Inherited from OPCUASecureObject.once
- 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 OPCUABaseServer

prependListener

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

Inherited from OPCUASecureObject.prependListener
- 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 OPCUABaseServer

prependOnceListener

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

Inherited from OPCUASecureObject.prependOnceListener
- 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 OPCUABaseServer

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): OPCUABaseServer

Inherited from OPCUASecureObject.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns OPCUABaseServer

removeListener

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

Inherited from OPCUASecureObject.removeListener
- 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 OPCUABaseServer

resumeEndPoints

resumeEndPoints(): Promise<void>
resumeEndPoints(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/source/base_server.ts:461
set all the end point into a state where they do accept connections note: this method is useful for testing purpose

Returns Promise<void>
- Defined in packages/node-opcua-server/source/base_server.ts:462
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): OPCUABaseServer

Inherited from OPCUASecureObject.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns OPCUABaseServer

shutdown

shutdown(done: (err?: Error) => void): void

- Defined in packages/node-opcua-server/source/base_server.ts:280
shutdown all server endPoints

async

Parameters
- done: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

shutdownChannels

shutdownChannels(): Promise<void>
shutdownChannels(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/source/base_server.ts:299
Returns Promise<void>
- Defined in packages/node-opcua-server/source/base_server.ts:300
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

start

start(done: (err?: Error) => void): void

- Defined in packages/node-opcua-server/source/base_server.ts:208
start all registered endPoint, in parallel, and call done when all endPoints are listening.

method

start

async

Parameters
- done: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

suspendEndPoints

suspendEndPoints(): Promise<void>
suspendEndPoints(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-server/source/base_server.ts:430
set all the end point into a state where they do not accept further connections

note: this method is useful for testing purpose

Returns Promise<void>
- Defined in packages/node-opcua-server/source/base_server.ts:431
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

Static listenerCount

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

Inherited from OPCUASecureObject.listenerCount
- 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>

Inherited from OPCUASecureObject.on
- 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[]>

Inherited from OPCUASecureObject.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from OPCUASecureObject.once
- 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

Optional options: OPCUABaseServerOptions

Returns OPCUABaseServer

Properties

capabilitiesForMDNS

Readonly certificateFile

endpoints

Readonly privateKeyFile

Readonly serverCertificateManager

serverInfo

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Static makeServiceFault

Type declaration

Parameters

statusCode: StatusCode

messages: string[]

Returns ServiceFault

Accessors

serverType

Returns ApplicationType

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns OPCUABaseServer

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getCertificate

Returns Buffer

getCertificateChain

Returns Buffer

getDiscoveryUrls

Returns string[]

getEndpointUrl

Returns string

getMaxListeners

Returns number

getPrivateKey

Returns string

getServers

Parameters

channel: ServerSecureChannelLayer

Returns ApplicationDescription[]

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns OPCUABaseServer