Class OPCUADiscoveryServer

subscribe now with sterfive to access the online-user manual

Hierarchy

OPCUABaseServer
- OPCUADiscoveryServer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OPCUADiscoveryServer(options: OPCUADiscoveryServerOptions): OPCUADiscoveryServer

Overrides OPCUABaseServer.constructor
- Defined in node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:17
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

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 node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:25
returns the number of registered servers

Returns number

serverType

get serverType(): ApplicationType

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

Returns ApplicationType

Methods

getCertificate

getCertificate(): Buffer

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

getCertificateChain

getCertificateChain(): Buffer

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

getDiscoveryUrls

getDiscoveryUrls(): string[]

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

getEndpointUrl

getEndpointUrl(): string

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

Returns string

getPrivateKey

getPrivateKey(): string

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

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

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

initializeCM

initializeCM(): Promise<void>

Inherited from OPCUABaseServer.initializeCM
- Defined in node-opcua-server/dist/base_server.d.ts:42
Returns Promise<void>

resumeEndPoints

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

Inherited from OPCUABaseServer.resumeEndPoints
- Defined in 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 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

shutdown

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

Overrides OPCUABaseServer.shutdown
- Defined in node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:20
shutdown all server endPoints

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

shutdownChannels

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

Inherited from OPCUABaseServer.shutdownChannels
- Defined in node-opcua-server/dist/base_server.d.ts:57
Returns Promise<void>
Inherited from OPCUABaseServer.shutdownChannels
- Defined in 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 node-opcua-server-discovery/dist/opcua_discovery_server.d.ts:18
start all registered endPoint, in parallel, and call done when all endPoints are listening.

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

suspendEndPoints

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

Inherited from OPCUABaseServer.suspendEndPoints
- Defined in 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 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

Generated using TypeDoc