OPCUAClientBase | node-opcua-client

Hierarchy

OPCUASecureObject
EventEmitter
- OPCUAClientBase
  - OPCUAClient

Implements

ICertificateKeyPairProvider

Implemented by

Index

Constructors

constructor

Constructors

constructor

new OPCUAClientBase(options: IOPCUASecureObjectOptions): OPCUAClientBase

Inherited from OPCUASecureObject.__constructor
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:29
Parameters
- options: IOPCUASecureObjectOptions
Returns OPCUAClientBase

Properties

applicationName

applicationName: string

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

Optional endpoint

endpoint: EndpointDescription

endpointUrl

endpointUrl: string

isReconnecting

isReconnecting: boolean

keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

keepSessionAlive

keepSessionAlive: boolean

knowsServerEndpoint

knowsServerEndpoint: boolean

privateKeyFile

privateKeyFile: string

protocolVersion

protocolVersion: 0

reconnectOnFailure

reconnectOnFailure: boolean

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

Optional serverCertificate

serverCertificate: Certificate

tokenRenewalInterval

tokenRenewalInterval: number

transactionsPerformed

transactionsPerformed: number

Static defaultMaxListeners

defaultMaxListeners: number

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
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 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 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 node-opcua-client/source/client_base.ts:146
causes client to close and disconnect the communication with server

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

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

findEndpointForSecurity

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

- Defined in 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 node-opcua-client/source/client_base.ts:159
Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
- Defined in node-opcua-client/source/client_base.ts:161
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
- Defined in node-opcua-client/source/client_base.ts:163
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 node-opcua-client/source/client_base.ts:165
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
- Defined in node-opcua-client/source/client_base.ts:167
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
- Defined in node-opcua-client/source/client_base.ts:169
Parameters
- options: FindServersOnNetworkRequestLike
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void

getCertificate

getCertificate(): Certificate

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

getCertificateChain

getCertificateChain(): Certificate

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

getEndpoints

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

- Defined in node-opcua-client/source/client_base.ts:153
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
- Defined in node-opcua-client/source/client_base.ts:155
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
- Defined in node-opcua-client/source/client_base.ts:157
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

getPrivateKey

getPrivateKey(): PrivateKeyPEM

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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 EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:182
this Event is raised when the initial connection has succeeded

Parameters
- event: "connected"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:189
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:196
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:206
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:215
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:226
this event is raised after the client has successfully manage to re-establish the connection with the remote OPCUA Server. You can intercept start_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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:233
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:240
this event is raised when the connection is closed

Parameters
- event: "close"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:248
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:256
this event is raised when the client has recevied 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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:258
Parameters
- event: "send_request"
- eventHandler: function
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:260
Parameters
- event: "receive_response"
- eventHandler: function
  - - (response: Response): void
    - Parameters
      - response: Response
      Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:268
this event is raised when the current security token has reached 75% of its livetime and is therefore about to expired.

Parameters
- event: "lifetime_75"
- eventHandler: function
  - - (token: SecurityToken): void
    - Parameters
      - token: SecurityToken
      Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:276
this event is raised after the (about ) security token as been renewed and renegociated with the server.to expire

Parameters
- event: "security_token_renewed"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:283
this event is raised when a broken connection with the remote Server has been reestablished

Parameters
- event: "connection_lost"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:290
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:298
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 OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:300
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 EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
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 EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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 EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
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 EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

Static create

create(options: OPCUAClientBaseOptions): OPCUAClientBase

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IOPCUASecureObjectOptions

Returns OPCUAClientBase

Properties

applicationName

bytesRead

bytesWritten

certificateFile

clientName

connectionStrategy

defaultSecureTokenLifetime

Optional endpoint

endpointUrl

isReconnecting

keepPendingSessionsOnDisconnect

keepSessionAlive

knowsServerEndpoint

privateKeyFile

protocolVersion

reconnectOnFailure

securityMode

securityPolicy

Optional serverCertificate

tokenRenewalInterval

transactionsPerformed

Static defaultMaxListeners

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

callback: ResponseCallback<ApplicationDescription[]>