Class OPCUABaseServer

subscribe now with sterfive to access the online-user manual

Hierarchy

OPCUASecureObject
- OPCUABaseServer
  - OPCUADiscoveryServer

Index

Constructors

constructor

Properties

Accessors

serverType

Methods

Constructors

constructor

new OPCUABaseServer(options?: OPCUABaseServerOptions): OPCUABaseServer

Overrides OPCUASecureObject.constructor
- Defined in node-opcua-server/dist/base_server.d.ts:40
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

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 node-opcua-server/dist/base_server.d.ts:33
The type of server

Returns ApplicationType

Methods

getCertificate

getCertificate(): Buffer

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

getCertificateChain

getCertificateChain(): Buffer

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

getDiscoveryUrls

getDiscoveryUrls(): string[]

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

getEndpointUrl

getEndpointUrl(): string

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

Returns string

getPrivateKey

getPrivateKey(): string

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

getServers

getServers(channel: ServerSecureChannelLayer): ApplicationDescription[]

- Defined in node-opcua-server/dist/base_server.d.ts:72
Parameters
- channel: ServerSecureChannelLayer
Returns ApplicationDescription[]

initializeCM

initializeCM(): Promise<void>

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

resumeEndPoints

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

- 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>
- 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(done: (err?: Error) => void): void

- Defined in node-opcua-server/dist/base_server.d.ts:56
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 node-opcua-server/dist/base_server.d.ts:57
Returns Promise<void>
- 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(done: (err?: Error) => void): void

- Defined in node-opcua-server/dist/base_server.d.ts:49
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 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>
- 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