Class OPCUABaseServer

Hierarchy

OPCUASecureObject
- OPCUABaseServer
  - OPCUAServer

Implements

ICertificateKeyPairProvider

Constructors

constructor

Properties

Accessors

serverType

Constructors

constructor

new OPCUABaseServer(options?: OPCUABaseServerOptions): OPCUABaseServer

Overrides OPCUAClientBase.constructor
- Defined in packages/node-opcua-server/source/base_server.ts:128
Parameters
- Optional options: OPCUABaseServerOptions
Returns OPCUABaseServer

Properties

capabilitiesForMDNS

capabilitiesForMDNS: string[]

Readonly certificateFile

certificateFile: string

endpoints

endpoints: OPCUAServerEndPoint[]

Readonly privateKeyFile

privateKeyFile: string

serverCertificateManager

serverCertificateManager: OPCUACertificateManager

serverInfo

serverInfo: ApplicationDescription

Static makeServiceFault

makeServiceFault: makeServiceFault = makeServiceFault

Accessors

serverType

get serverType(): ApplicationType

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

Returns ApplicationType

Methods

_get_endpoints

_get_endpoints(endpointUrl: string | null): EndpointDescription[]

- Defined in packages/node-opcua-server/source/base_server.ts:331
Parameters
- endpointUrl: string | null
Returns EndpointDescription[]

addListener

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

Inherited from UAStateVariable.addListener
- Defined in node_modules/@types/node/events.d.ts:62
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 UAStateVariable.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

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

getCertificateChain

getCertificateChain(): Certificate

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

getDiscoveryUrls

getDiscoveryUrls(): string[]

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

getMaxListeners

getMaxListeners(): number

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

getPrivateKey

getPrivateKey(): PrivateKeyPEM

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

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAStateVariable.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 UAStateVariable.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from UAStateVariable.off
- Defined in node_modules/@types/node/events.d.ts:66
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 NonHierarchicalReferences.on
- Defined in node_modules/@types/node/events.d.ts:63
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 packages/node-opcua-server/source/base_server.ts:271
Parameters
- message: Message
- channel: ServerSecureChannelLayer
Returns void

once

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

Inherited from NonHierarchicalReferences.once
- Defined in node_modules/@types/node/events.d.ts:64
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

Inherited from UAStateVariable.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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 UAStateVariable.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
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 UAStateVariable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

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

removeListener

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

Inherited from UAStateVariable.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
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 packages/node-opcua-server/source/base_server.ts:393
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:394
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): this

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

shutdown

shutdown(done: function): void

- Defined in packages/node-opcua-server/source/base_server.ts:223
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 packages/node-opcua-server/source/base_server.ts:242
Returns Promise<void>
- Defined in packages/node-opcua-server/source/base_server.ts:243
Parameters
- callback: function
  - - (err?: Error | null): void
    - Parameters
      - Optional err: Error | null
      Returns void
Returns void

start

start(done: function): void

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

Generated using TypeDoc