OPCUAServer | NodeOPCUA reference documentation

Hierarchy

OPCUABaseServer
EventEmitter
- OPCUAServer

Index

Constructors

constructor

Events

Accessors

Methods

Constructors

constructor

new OPCUAServer(options?: OPCUAServerOptions): OPCUAServer

Inherited from OPCUABaseServer.constructor
- Defined in node-opcua-server/dist/opcua_server.d.ts:316
Parameters
- Optional options: OPCUAServerOptions
Returns OPCUAServer

Events

on

on(event: "create_session", eventHandler: (session: ServerSession) => void): OPCUAServer
on(event: "session_activated", eventHandler: (session: ServerSession) => void): OPCUAServer
on(event: "session_closed", eventHandler: (session: ServerSession, reason: string) => void): OPCUAServer
on(event: "post_initialize", eventHandler: () => void): OPCUAServer
on(event: "serverRegistrationPending", eventHandler: () => void): OPCUAServer
on(event: "serverRegistered", eventHandler: () => void): OPCUAServer
on(event: "serverRegistrationRenewed", eventHandler: () => void): OPCUAServer
on(event: "serverUnregistered", eventHandler: () => void): OPCUAServer
on(event: "event", eventHandler: (eventData: any) => void): OPCUAServer
on(event: "request", eventHandler: (request: Request, channel: ServerSecureChannelLayer) => void): OPCUAServer
on(event: "response", eventHandler: (request: Response, channel: ServerSecureChannelLayer) => void): OPCUAServer
on(event: "newChannel", eventHandler: (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint) => void): OPCUAServer
on(event: "closeChannel", eventHandler: (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint) => void): OPCUAServer
on(event: "connectionRefused", eventHandler: (socketData: ISocketData, endpoint: OPCUAServerEndPoint) => void): OPCUAServer
on(event: "openSecureChannelFailure", eventHandler: (socketData: ISocketData, channelData: IChannelData, endpoint: OPCUAServerEndPoint) => void): OPCUAServer
on(event: string, eventHandler: (...args: [any?, ...any[]]) => void): OPCUAServer

- Defined in node-opcua-server/dist/opcua_server.d.ts:588
Parameters
- event: "create_session"
- eventHandler: (session: ServerSession) => void
  - - (session: ServerSession): void
    - Parameters
      - session: ServerSession
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:589
Parameters
- event: "session_activated"
- eventHandler: (session: ServerSession) => void
  - - (session: ServerSession): void
    - Parameters
      - session: ServerSession
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:590
Parameters
- event: "session_closed"
- eventHandler: (session: ServerSession, reason: string) => void
  - - (session: ServerSession, reason: string): void
    - Parameters
      - session: ServerSession
      - reason: string
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:591
Parameters
- event: "post_initialize"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:599
emitted when the server is trying to registered the LDS but when the connection to the lds has failed serverRegistrationPending is sent when the backoff signal of the connection process is raised

Parameters
- event: "serverRegistrationPending"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:604
event raised when server has been successfully registered on the local discovery server

Parameters
- event: "serverRegistered"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:609
event raised when server registration has been successfully renewed on the local discovery server

Parameters
- event: "serverRegistrationRenewed"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:614
event raised when server has been successfully unregistered from the local discovery server

Parameters
- event: "serverUnregistered"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:618
event raised after the server has raised an OPCUA event toward a client

Parameters
- event: "event"
- eventHandler: (eventData: any) => void
  - - (eventData: any): void
    - Parameters
      - eventData: any
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:623
event raised when the server received a request from one of its connected client. useful for trace purpose.

Parameters
- event: "request"
- eventHandler: (request: Request, channel: ServerSecureChannelLayer) => void
  - - (request: Request, channel: ServerSecureChannelLayer): void
    - Parameters
      - request: Request
      - channel: ServerSecureChannelLayer
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:628
event raised when the server send an response to a request to one of its connected client. useful for trace purpose.

Parameters
- event: "response"
- eventHandler: (request: Response, channel: ServerSecureChannelLayer) => void
  - - (request: Response, channel: ServerSecureChannelLayer): void
    - Parameters
      - request: Response
      - channel: ServerSecureChannelLayer
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:632
event raised when a new secure channel is opened

Parameters
- event: "newChannel"
- eventHandler: (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint) => void
  - - (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint): void
    - Parameters
      - channel: ServerSecureChannelLayer
      - endpoint: OPCUAServerEndPoint
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:636
event raised when a new secure channel is closed

Parameters
- event: "closeChannel"
- eventHandler: (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint) => void
  - - (channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint): void
    - Parameters
      - channel: ServerSecureChannelLayer
      - endpoint: OPCUAServerEndPoint
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:640
event raised when the server refused a tcp connection from a client. ( for instance because too any connections)

Parameters
- event: "connectionRefused"
- eventHandler: (socketData: ISocketData, endpoint: OPCUAServerEndPoint) => void
  - - (socketData: ISocketData, endpoint: OPCUAServerEndPoint): void
    - Parameters
      - socketData: ISocketData
      - endpoint: OPCUAServerEndPoint
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:644
event raised when a OpenSecureChannel has failed, it could be a invalid certificate or malformed message

Parameters
- event: "openSecureChannelFailure"
- eventHandler: (socketData: ISocketData, channelData: IChannelData, endpoint: OPCUAServerEndPoint) => void
  - - (socketData: ISocketData, channelData: IChannelData, endpoint: OPCUAServerEndPoint): void
    - Parameters
      - socketData: ISocketData
      - channelData: IChannelData
      - endpoint: OPCUAServerEndPoint
      Returns void
Returns OPCUAServer
- Defined in node-opcua-server/dist/opcua_server.d.ts:645
Parameters
- event: string
- eventHandler: (...args: [any?, ...any[]]) => void
  - - (...args: [any?, ...any[]]): void
    - Parameters
      - Rest ...args: [any?, ...any[]]
      Returns void
Returns OPCUAServer

Properties

allowAnonymous

allowAnonymous: boolean

false if anonymous connection are not allowed

capabilitiesForMDNS

capabilitiesForMDNS: string[]

Readonly certificateFile

certificateFile: string

discoveryServerEndpointUrl

discoveryServerEndpointUrl: string

endpoints

endpoints: OPCUAServerEndPoint[]

engine

engine: ServerEngine

maxAllowedSessionNumber

maxAllowedSessionNumber: number

the maximum number of concurrent sessions allowed on the server

maxConnectionsPerEndpoint

maxConnectionsPerEndpoint: number

the maximum number for concurrent connection per end point

Readonly options

options: OPCUAServerOptions

Readonly privateKeyFile

privateKeyFile: string

Optional registerServerManager

registerServerManager: IRegisterServerManager

registerServerMethod

registerServerMethod: RegisterServerMethod

Readonly serverCertificateManager

serverCertificateManager: OPCUACertificateManager

serverInfo

serverInfo: ApplicationDescription

userCertificateManager

userCertificateManager: OPCUACertificateManager

userManager

userManager: UAUserManagerBase

the user manager

Static MAX_SUBSCRIPTION

MAX_SUBSCRIPTION: number

the maximum number of subscription that can be created per server

Static defaultShutdownTimeout

defaultShutdownTimeout: number

Static fallbackSessionName

fallbackSessionName: string

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

Static registry

registry: ObjectRegistry

Static requestExactEndpointUrl

requestExactEndpointUrl: boolean

if requestExactEndpointUrl is set to true the server will only accept createSession that have a endpointUrl that strictly matches one of the provided endpoint. This mean that if the server expose a endpoint with url such as opc.tcp://MYHOSTNAME:1234, client will not be able to reach the server with the ip address of the server. requestExactEndpointUrl = true => emulates the Prosys Server behavior requestExactEndpointUrl = false => emulates the Unified Automation behavior.

Accessors

buildInfo

get buildInfo(): BuildInfo

- Defined in node-opcua-server/dist/opcua_server.d.ts:253
The server build info

Returns BuildInfo

bytesRead

get bytesRead(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:245
total number of bytes read by the server since startup

Returns number

bytesWritten

get bytesWritten(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:241
total number of bytes written by the server since startup

Returns number

currentChannelCount

get currentChannelCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:257
the number of connected channel on all existing end points

Returns number

currentSessionCount

get currentSessionCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:281
the number of sessions currently active

Returns number

currentSubscriptionCount

get currentSubscriptionCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:261
The number of active subscriptions from all sessions

Returns number

initialized

get initialized(): boolean

- Defined in node-opcua-server/dist/opcua_server.d.ts:286
true if the server has been initialized

Returns boolean

isAuditing

get isAuditing(): boolean

- Defined in node-opcua-server/dist/opcua_server.d.ts:290
is the server auditing ?

Returns boolean

publishingIntervalCount

get publishingIntervalCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:277
the publishing interval count

Returns number

rejectedRequestsCount

get rejectedRequestsCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:269
the number of request that have been rejected

Returns number

rejectedSessionCount

get rejectedSessionCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:265
the number of session activation requests that have been rejected

Returns number

serverType

get serverType(): ApplicationType

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

Returns ApplicationType

sessionAbortCount

get sessionAbortCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:273
the number of sessions that have been aborted

Returns number

transactionsCount

get transactionsCount(): number

- Defined in node-opcua-server/dist/opcua_server.d.ts:249
Number of transactions processed by the server since startup

Returns number

Methods

dispose

dispose(): void

- Defined in node-opcua-server/dist/opcua_server.d.ts:376
Returns void

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/source/base_server.ts:429
Returns string[]

getEndpointUrl

getEndpointUrl(): string

Inherited from OPCUABaseServer.getEndpointUrl
- Defined in node-opcua-server/source/base_server.ts:425
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[]

Inherited from OPCUABaseServer.getServers
- Defined in node-opcua-server/source/base_server.ts:436
Parameters
- channel: ServerSecureChannelLayer
Returns ApplicationDescription[]

initialize

initialize(): Promise<void>
initialize(done: () => void): void

Initialize the server by installing default node set.

and instruct the server to listen to its endpoints.

const server = new OPCUAServer();
await server.initialize();

// default server namespace is now initialized
// it is a good time to create life instance objects
const namespace = server.engine.addressSpace.getOwnNamespace();
namespace.addObject({
    browseName: "SomeObject",
    organizedBy: server.engine.addressSpace.rootFolder.objects
});

// the addressSpace is now complete
// let's now start listening to clients
await server.start();

Returns Promise<void>

- Defined in node-opcua-server/dist/opcua_server.d.ts:340
Parameters
- done: () => void
  - - (): void
    - Returns void
Returns void

initializeCM

initializeCM(): Promise<void>

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

raiseEvent

raiseEvent(eventType: "AuditCreateSessionEventType", options: RaiseEventAuditCreateSessionEventData): void
raiseEvent(eventType: "AuditActivateSessionEventType", options: RaiseEventAuditActivateSessionEventData): void
raiseEvent(eventType: "AuditCreateSessionEventType", options: RaiseEventData): void
raiseEvent(eventType: "AuditConditionCommentEventType", options: RaiseEventAuditConditionCommentEventData): void
raiseEvent(eventType: "AuditUrlMismatchEventType", options: RaiseEventAuditUrlMismatchEventTypeData): void
raiseEvent(eventType: "TransitionEventType", options: RaiseEventTransitionEventData): void

- Defined in ../node-opcua-server/dist/opcua_server.d.ts:580
Parameters
- eventType: "AuditCreateSessionEventType"
- options: RaiseEventAuditCreateSessionEventData
Returns void
- Defined in ../node-opcua-server/dist/opcua_server.d.ts:581
Parameters
- eventType: "AuditActivateSessionEventType"
- options: RaiseEventAuditActivateSessionEventData
Returns void
- Defined in ../node-opcua-server/dist/opcua_server.d.ts:582
Parameters
- eventType: "AuditCreateSessionEventType"
- options: RaiseEventData
Returns void
- Defined in ../node-opcua-server/dist/opcua_server.d.ts:583
Parameters
- eventType: "AuditConditionCommentEventType"
- options: RaiseEventAuditConditionCommentEventData
Returns void
- Defined in ../node-opcua-server/dist/opcua_server.d.ts:584
Parameters
- eventType: "AuditUrlMismatchEventType"
- options: RaiseEventAuditUrlMismatchEventTypeData
Returns void
- Defined in ../node-opcua-server/dist/opcua_server.d.ts:585
Parameters
- eventType: "TransitionEventType"
- options: RaiseEventTransitionEventData
Returns void

resumeEndPoints

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

Inherited from OPCUABaseServer.resumeEndPoints
- Defined in node-opcua-server/source/base_server.ts:481
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/source/base_server.ts:482
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

shutdown

shutdown(timeout?: number): Promise<void>
shutdown(callback: (err?: Error) => void): void
shutdown(timeout: number, callback: (err?: Error) => void): void

shutdown all server endpoints

method

shutdown

async

example

   // shutdown immediately
   server.shutdown(function(err) {
   });

  // in typescript with promises
  server.shutdown(10000).then(()=>{
     console.log("Server has shutdown");
  });

   // shutdown within 10 seconds
   server.engine.shutdownReason = coerceLocalizedText("Shutdown for maintenance");
   server.shutdown(10000,function(err) {
   });

Parameters

Optional timeout: number

the timeout (in ms) before the server is actually shutdown

Returns Promise<void>

- Defined in node-opcua-server/dist/opcua_server.d.ts:374
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void
- Defined in node-opcua-server/dist/opcua_server.d.ts:375
Parameters
- timeout: number
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

shutdownChannels

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

Inherited from OPCUABaseServer.shutdownChannels
- Defined in node-opcua-server/source/base_server.ts:316
Returns Promise<void>
Inherited from OPCUABaseServer.shutdownChannels
- Defined in node-opcua-server/source/base_server.ts:317
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

start

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

Inherited from OPCUABaseServer.start
- Defined in node-opcua-server/dist/opcua_server.d.ts:345
Initiate the server by starting all its endpoints

async

Returns Promise<void>
- Defined in node-opcua-server/dist/opcua_server.d.ts:346
Parameters
- done: () => void
  - - (): void
    - Returns void
Returns void

suspendEndPoints

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

Inherited from OPCUABaseServer.suspendEndPoints
- Defined in node-opcua-server/source/base_server.ts:449
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/source/base_server.ts:450
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: OPCUAServerOptions

Returns OPCUAServer

Events

on

Parameters

event: "create_session"

eventHandler: (session: ServerSession) => void

Parameters

session: ServerSession

Returns void

Returns OPCUAServer

Parameters

event: "session_activated"

eventHandler: (session: ServerSession) => void

Parameters

session: ServerSession

Returns void

Returns OPCUAServer

Parameters

event: "session_closed"

eventHandler: (session: ServerSession, reason: string) => void

Parameters

session: ServerSession

reason: string

Returns void

Returns OPCUAServer

Parameters

event: "post_initialize"

eventHandler: () => void

Returns void

Returns OPCUAServer

Parameters

event: "serverRegistrationPending"

eventHandler: () => void

Returns void

Returns OPCUAServer

Parameters

event: "serverRegistered"

eventHandler: () => void

Returns void

Returns OPCUAServer

Parameters

event: "serverRegistrationRenewed"

eventHandler: () => void

Returns void

Returns OPCUAServer

Parameters

event: "serverUnregistered"

eventHandler: () => void

Returns void

Returns OPCUAServer

Parameters

event: "event"

eventHandler: (eventData: any) => void

Parameters

eventData: any

Returns void

Returns OPCUAServer

Parameters

event: "request"

eventHandler: (request: Request, channel: ServerSecureChannelLayer) => void

Parameters

request: Request

channel: ServerSecureChannelLayer

Returns void

Returns OPCUAServer

Parameters

event: "response"

eventHandler: (request: Response, channel: ServerSecureChannelLayer) => void