Class OPCUAClientBase

Hierarchy

OPCUASecureObject
EventEmitter
- OPCUAClientBase
  - OPCUAClient

Implements

ICertificateKeyPairProvider

Implemented by

Constructors

constructor

Constructors

constructor

new OPCUAClientBase(options: IOPCUASecureObjectOptions): OPCUAClientBase

Inherited from OPCUAClientBase.constructor

Overrides ClientMonitoredItemBase.constructor
- Defined in packages/node-opcua-common/dist/opcua_secure_object.d.ts:26
Parameters
- options: IOPCUASecureObjectOptions
Returns OPCUAClientBase

Properties

Readonly applicationName

applicationName: string

Readonly bytesRead

bytesRead: number

Readonly bytesWritten

bytesWritten: number

Readonly certificateFile

certificateFile: string

Readonly clientName

clientName: string

Readonly connectionStrategy

connectionStrategy: ConnectionStrategy

Readonly defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

Optional Readonly endpoint

endpoint: EndpointDescription

Readonly endpointUrl

endpointUrl: string

Readonly isReconnecting

isReconnecting: boolean

Readonly keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

Readonly keepSessionAlive

keepSessionAlive: boolean

Readonly knowsServerEndpoint

knowsServerEndpoint: boolean

Readonly privateKeyFile

privateKeyFile: string

Readonly protocolVersion

protocolVersion: 0

Readonly reconnectOnFailure

reconnectOnFailure: boolean

Readonly securityMode

securityMode: MessageSecurityMode

Readonly securityPolicy

securityPolicy: SecurityPolicy

Optional Readonly serverCertificate

serverCertificate: Certificate

Readonly tokenRenewalInterval

tokenRenewalInterval: number

Readonly transactionsPerformed

transactionsPerformed: number

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

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 registry

registry: ObjectRegistry = new ObjectRegistry()

Methods

addListener

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

Inherited from UAStateVariable.addListener

Overrides 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

connect

connect(endpointUrl: string): Promise<void>
connect(endpointUrl: string, callback: ErrorCallback): void

- Defined in packages/node-opcua-client/source/client_base.ts:139
Parameters
- endpointUrl: string
  
  the endpoint of the server to connect to ( i.e "opc.tcp://machine.name:3434/name" )
Returns Promise<void>
- Defined in packages/node-opcua-client/source/client_base.ts:141
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

disconnect

disconnect(): Promise<void>
disconnect(callback: ErrorCallback): void

- Defined in packages/node-opcua-client/source/client_base.ts:146
causes client to close and disconnect the communication with server

Returns Promise<void>
- Defined in packages/node-opcua-client/source/client_base.ts:148
Parameters
- callback: ErrorCallback
Returns void

emit

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

Inherited from UAStateVariable.emit

Overrides 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

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

findEndpointForSecurity

findEndpointForSecurity(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined

- Defined in packages/node-opcua-client/source/client_base.ts:150
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns EndpointDescription | undefined

findServers

findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>
findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void
findServers(callback: ResponseCallback<ApplicationDescription[]>): void

- Defined in packages/node-opcua-client/source/client_base.ts:158
Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
- Defined in packages/node-opcua-client/source/client_base.ts:160
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:162
Parameters
- callback: ResponseCallback<ApplicationDescription[]>
Returns void

findServersOnNetwork

findServersOnNetwork(options?: FindServersOnNetworkRequestLike): Promise<ServerOnNetwork[]>
findServersOnNetwork(callback: ResponseCallback<ServerOnNetwork[]>): void
findServersOnNetwork(options: FindServersOnNetworkRequestLike, callback: ResponseCallback<ServerOnNetwork[]>): void

- Defined in packages/node-opcua-client/source/client_base.ts:164
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
- Defined in packages/node-opcua-client/source/client_base.ts:166
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:168
Parameters
- options: FindServersOnNetworkRequestLike
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void

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

getEndpoints

getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>
getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void
getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void

- Defined in packages/node-opcua-client/source/client_base.ts:152
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
- Defined in packages/node-opcua-client/source/client_base.ts:154
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:156
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from UAStateVariable.getMaxListeners

Overrides 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

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAStateVariable.listenerCount

Overrides 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

Overrides 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

Overrides 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
on(event: "connected", eventHandler: function): this
on(event: "connection_failed", eventHandler: function): this
on(event: "backoff", eventHandler: function): this
on(event: "start_reconnection", eventHandler: function): this
on(event: "reconnection_attempt_has_failed", eventHandler: function): this
on(event: "after_reconnection", eventHandler: function): this
on(event: "abort", eventHandler: function): this
on(event: "close", eventHandler: function): this
on(event: "send_chunk", eventHandler: function): this
on(event: "receive_chunk", eventHandler: function): this
on(event: "send_request", eventHandler: function): this
on(event: "receive_response", eventHandler: function): this
on(event: "lifetime_75", eventHandler: function): this
on(event: "security_token_renewed", eventHandler: function): this
on(event: "connection_lost", eventHandler: function): this
on(event: "connection_reestablished", eventHandler: function): this
on(event: "timed_out_request", eventHandler: function): this
on(event: string | symbol, listener: function): this

Inherited from NonHierarchicalReferences.on

Overrides 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
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:180
this Event is raised when the initial connection has succeeded

Parameters
- event: "connected"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:187
this Event is raised when the initial connection has failed

Parameters
- event: "connection_failed"
- eventHandler: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:194
this Event is raised when a failing connection is about to be tried again

Parameters
- event: "backoff"
- eventHandler: function
  - - (count: number, delay: number): void
    - Parameters
      - count: number
      - delay: number
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:204
this event is raised when the client has encountered a connection failure and and is going to reconnection mode. You can intercept start_reconnection event to pause your interaction with the remote OPCUA server.

Parameters
- event: "start_reconnection"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:213
this event is raised when the client has failed one attempt to reconnect to the server This event will be raised if the socket has successfully being created to the server but if something went wrong during the reconnection process.

Parameters
- event: "reconnection_attempt_has_failed"
- eventHandler: function
  - - (err: Error, message: string): void
    - Parameters
      - err: Error
      - message: string
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:224
this event is raised after the client has successfully managed to re-establish the connection with the remote OPCUA Server. You can intercept after_reconnection event to resume your interaction with the remote OPCUA server.

Parameters
- event: "after_reconnection"
- eventHandler: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:231
the event is raised when the connection has been aborted by the remote OPCUA Server

Parameters
- event: "abort"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:238
this event is raised when the connection is closed

Parameters
- event: "close"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:246
this event is raised when the client is sending a message chunk to the server (advanced use only)

Parameters
- event: "send_chunk"
- eventHandler: function
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:254
this event is raised when the client has received a new message chunk from the servers (advanced use only)

Parameters
- event: "receive_chunk"
- eventHandler: function
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:256
Parameters
- event: "send_request"
- eventHandler: function
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:258
Parameters
- event: "receive_response"
- eventHandler: function
  - - (response: Response): void
    - Parameters
      - response: Response
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:266
this event is raised when the current security token has reached 75% of its lifetime and is therefore about to expired.

Parameters
- event: "lifetime_75"
- eventHandler: function
  - - (token: SecurityToken): void
    - Parameters
      - token: SecurityToken
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:274
this event is raised after the (about ) security token as been renewed and renegotiated with the server.to expire

Parameters
- event: "security_token_renewed"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:281
this event is raised when the connection has been broken

Parameters
- event: "connection_lost"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:288
this event is raised when a broken connection with the remote Server has been reestablished

Parameters
- event: "connection_reestablished"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:296
This event is raised when a request sent to the remote OPCUA server has reach it's timeout value without a Response from the server.

Parameters
- event: "timed_out_request"
- eventHandler: function
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns this
Inherited from NonHierarchicalReferences.on

Overrides NonHierarchicalReferences.on
- Defined in packages/node-opcua-client/source/client_base.ts:298
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

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

Inherited from NonHierarchicalReferences.once

Overrides 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

Overrides 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

Overrides 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

Overrides 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

Overrides 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

Overrides 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

setMaxListeners

setMaxListeners(n: number): this

Inherited from UAStateVariable.setMaxListeners

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

Static create

create(options: OPCUAClientBaseOptions): OPCUAClientBase

- Defined in packages/node-opcua-client/source/client_base.ts:327
Parameters
- options: OPCUAClientBaseOptions
Returns OPCUAClientBase

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from ConditionSnapshot.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Class OPCUAClientBase

Hierarchy

Implements

Implemented by

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IOPCUASecureObjectOptions

Returns OPCUAClientBase

Properties

Readonly applicationName

Readonly bytesRead

Readonly bytesWritten

Readonly certificateFile

Readonly clientName

Readonly connectionStrategy

Readonly defaultSecureTokenLifetime

Optional Readonly endpoint

Readonly endpointUrl

Readonly isReconnecting

Readonly keepPendingSessionsOnDisconnect

Readonly keepSessionAlive

Readonly knowsServerEndpoint

Readonly privateKeyFile

Readonly protocolVersion

Readonly reconnectOnFailure

Readonly securityMode

Readonly securityPolicy

Optional Readonly serverCertificate

Readonly tokenRenewalInterval

Readonly transactionsPerformed

Static defaultMaxListeners

Static Readonly errorMonitor

Static registry

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

connect

Parameters

endpointUrl: string

Returns Promise<void>

Parameters

endpointUrl: string

callback: ErrorCallback

Returns void

disconnect

Returns Promise<void>

Parameters

callback: ErrorCallback

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

findEndpointForSecurity

Parameters

securityMode: MessageSecurityMode

securityPolicy: SecurityPolicy

Returns EndpointDescription | undefined

findServers

Parameters

Optional options: FindServersRequestLike

Returns Promise<ApplicationDescription[]>

Parameters

options: FindServersRequestLike

callback: ResponseCallback<ApplicationDescription[]>

Returns void

Parameters