OPCUADiscoveryServer | NodeOPCUA reference documentation

Hierarchy

OPCUABaseServer
- OPCUADiscoveryServer

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new OPCUADiscoveryServer(options: OPCUADiscoveryServerOptions): OPCUADiscoveryServer

Inherited from OPCUABaseServer.constructor
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:13
Parameters
- options: OPCUADiscoveryServerOptions
Returns OPCUADiscoveryServer

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

registeredServerCount

get registeredServerCount(): number

- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:22
returns the number of registered servers

Returns number

serverType

get serverType(): ApplicationType

- Defined in packages/node-opcua-server/dist/base_server.d.ts:33
The type of server

Returns ApplicationType

Methods

addListener

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

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

emit

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

Inherited from OPCUABaseServer.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 OPCUABaseServer.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getCertificate

getCertificate(): Buffer

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

getCertificateChain

getCertificateChain(): Buffer

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

getDiscoveryUrls

getDiscoveryUrls(): string[]

Inherited from OPCUABaseServer.getDiscoveryUrls
- Defined in packages/node-opcua-server/dist/base_server.d.ts:71
Returns string[]

getEndpointUrl

getEndpointUrl(): string

Inherited from OPCUABaseServer.getEndpointUrl
- Defined in packages/node-opcua-server/dist/base_server.d.ts:70
get one of the possible endpointUrl

Returns string

getMaxListeners

getMaxListeners(): number

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

getPrivateKey

getPrivateKey(): string

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

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

Overrides OPCUABaseServer.getServers
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:23
Parameters
- channel: ServerSecureChannelLayer
Returns ApplicationDescription[]

listenerCount

listenerCount(event: string | symbol): number

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

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

on

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

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

once

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

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

prependListener

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

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

prependOnceListener

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

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

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): OPCUADiscoveryServer

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

removeListener

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

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

resumeEndPoints

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

Inherited from OPCUABaseServer.resumeEndPoints
- Defined in packages/node-opcua-server/dist/base_server.d.ts:87
set all the end point into a state where they do accept connections note: this method is useful for testing purpose

Returns Promise<void>
Inherited from OPCUABaseServer.resumeEndPoints
- Defined in packages/node-opcua-server/dist/base_server.d.ts:88
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

setMaxListeners

setMaxListeners(n: number): OPCUADiscoveryServer

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

shutdown

shutdown(): Promise<void>
shutdown(done: ErrorCallback): void

Overrides OPCUABaseServer.shutdown
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:17
Returns Promise<void>
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:18
Parameters
- done: ErrorCallback
Returns void

shutdownChannels

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

Inherited from OPCUABaseServer.shutdownChannels
- Defined in packages/node-opcua-server/dist/base_server.d.ts:57
Returns Promise<void>
Inherited from OPCUABaseServer.shutdownChannels
- Defined in packages/node-opcua-server/dist/base_server.d.ts:58
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

start

start(): Promise<void>
start(done: ErrorCallback): void

Overrides OPCUABaseServer.start
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:15
Returns Promise<void>
- Defined in packages/node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:16
Parameters
- done: ErrorCallback
Returns void

suspendEndPoints

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

Inherited from OPCUABaseServer.suspendEndPoints
- Defined in packages/node-opcua-server/dist/base_server.d.ts:80
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>
Inherited from OPCUABaseServer.suspendEndPoints
- Defined in packages/node-opcua-server/dist/base_server.d.ts:81
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 OPCUABaseServer.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 OPCUABaseServer.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 OPCUABaseServer.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from OPCUABaseServer.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

options: OPCUADiscoveryServerOptions

Returns OPCUADiscoveryServer

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

registeredServerCount

Returns number

serverType

Returns ApplicationType

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns OPCUADiscoveryServer

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[]