Class OPCUABaseServer

class: OPCUABaseServer
constructor

Hierarchy

OPCUASecureObject
- OPCUABaseServer
  - OPCUAServer

Implements

ICertificateKeyPairProvider

Index

Constructors

constructor

Properties

Accessors

serverType

Constructors

constructor

new OPCUABaseServer(options?: OPCUABaseServerOptions): OPCUABaseServer

Overrides OPCUASecureObject.__constructor
- Defined in node-opcua-server/source/base_server.ts:129
Parameters
- Optional options: OPCUABaseServerOptions
Returns OPCUABaseServer

Properties

capabilitiesForMDNS

capabilitiesForMDNS: string[]

certificateFile

certificateFile: string

endpoints

endpoints: OPCUAServerEndPoint[]

Protected options

options: OPCUABaseServerOptions

privateKeyFile

privateKeyFile: string

serverCertificateManager

serverCertificateManager: OPCUACertificateManager

serverInfo

serverInfo: ApplicationDescription

Static defaultMaxListeners

defaultMaxListeners: number

Static makeServiceFault

makeServiceFault: makeServiceFault = makeServiceFault

Accessors

serverType

get serverType(): ApplicationType

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

Returns ApplicationType

Methods

_get_endpoints

_get_endpoints(): EndpointDescription[]

- Defined in node-opcua-server/source/base_server.ts:301
Returns EndpointDescription[]

Private _on_FindServersRequest

_on_FindServersRequest(message: Message, channel: ServerSecureChannelLayer): void

- Defined in node-opcua-server/source/base_server.ts:411
Parameters
- message: Message
- channel: ServerSecureChannelLayer
Returns void

Private _on_GetEndpointsRequest

_on_GetEndpointsRequest(message: Message, channel: ServerSecureChannelLayer): void

- Defined in node-opcua-server/source/base_server.ts:376
Parameters
- message: Message
- channel: ServerSecureChannelLayer
Returns void

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

Inherited from OPCUASecureObject.getCertificate
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:31
Returns Certificate

getCertificateChain

getCertificateChain(): Certificate

Inherited from OPCUASecureObject.getCertificateChain
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:32
Returns Certificate

Protected getChannels

getChannels(): ServerSecureChannelLayer[]

- Defined in node-opcua-server/source/base_server.ts:463
returns a array of currently active channels

Returns ServerSecureChannelLayer[]

getDiscoveryUrls

getDiscoveryUrls(): string[]

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

getPrivateKey

getPrivateKey(): PrivateKeyPEM

Inherited from OPCUASecureObject.getPrivateKey
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:33
Returns PrivateKeyPEM

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on_request

on_request(message: Message, channel: ServerSecureChannelLayer): void

- Defined in node-opcua-server/source/base_server.ts:239
Parameters
- message: Message
- channel: ServerSecureChannelLayer
Returns void

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Protected prepare

prepare(message: Message, channel: ServerSecureChannelLayer): void

- Defined in node-opcua-server/source/base_server.ts:369
Parameters
- message: Message
- channel: ServerSecureChannelLayer
Returns void

prependListener

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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resumeEndPoints

resumeEndPoints(): Promise<void>
resumeEndPoints(callback: function): void

- Defined in node-opcua-server/source/base_server.ts:361
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 node-opcua-server/source/base_server.ts:362
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

shutdown

shutdown(done: function): void

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

async

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

shutdownChannels

shutdownChannels(): Promise<void>
shutdownChannels(callback: function): void

- Defined in node-opcua-server/source/base_server.ts:215
Returns Promise<void>
- Defined in node-opcua-server/source/base_server.ts:216
Parameters
- callback: function
  - - (err?: Error | null): void
    - Parameters
      - Optional err: Error | null
      Returns void
Returns void

start

start(done: function): void

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

method

start

async

Parameters
- done: function
  - - (err?: Error | null): void
    - Parameters
      - Optional err: Error | null
      Returns void
Returns void

suspendEndPoints

suspendEndPoints(): Promise<void>
suspendEndPoints(callback: function): void

- Defined in node-opcua-server/source/base_server.ts:332
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 node-opcua-server/source/base_server.ts:333
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc