OPCUAClientBase | NodeOPCUA reference documentation

Hierarchy

OPCUASecureObject
EventEmitter
- OPCUAClientBase
  - OPCUAClient
  - OPCUAClient

Index

Constructors

constructor

Constructors

constructor

new OPCUAClientBase(): OPCUAClientBase

Inherited from OPCUASecureObject.constructor

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: Buffer

Readonly tokenRenewalInterval

tokenRenewalInterval: number

Readonly transactionsPerformed

transactionsPerformed: number

Static registry

registry: ObjectRegistry = ...

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

connect

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

- Defined in packages/node-opcua-client/source/client_base.ts:154
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:156
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:161
causes client to close and disconnect the communication with server

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

emit

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

Inherited from OPCUASecureObject.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from OPCUASecureObject.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findEndpointForSecurity

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

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

findServers

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

- Defined in packages/node-opcua-client/source/client_base.ts:173
Parameters
- Optional options: FindServersRequestOptions
Returns Promise<ApplicationDescription[]>
- Defined in packages/node-opcua-client/source/client_base.ts:175
Parameters
- options: FindServersRequestOptions
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:177
Parameters
- callback: ResponseCallback<ApplicationDescription[]>
Returns void

findServersOnNetwork

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

- Defined in packages/node-opcua-client/source/client_base.ts:179
Parameters
- Optional options: FindServersOnNetworkRequestOptions
Returns Promise<ServerOnNetwork[]>
- Defined in packages/node-opcua-client/source/client_base.ts:181
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:183
Parameters
- options: FindServersOnNetworkRequestOptions
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void

getCertificate

getCertificate(): Buffer

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

getCertificateChain

getCertificateChain(): Buffer

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

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:167
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
- Defined in packages/node-opcua-client/source/client_base.ts:169
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/client_base.ts:171
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from OPCUASecureObject.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getPrivateKey

getPrivateKey(): string

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

listenerCount

listenerCount(event: string | symbol): number

Inherited from OPCUASecureObject.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 OPCUASecureObject.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

on

on(event: "connected", eventHandler: () => void): OPCUAClientBase
on(event: "connection_failed", eventHandler: (err: Error) => void): OPCUAClientBase
on(event: "backoff", eventHandler: (count: number, delay: number) => void): OPCUAClientBase
on(event: "start_reconnection", eventHandler: () => void): OPCUAClientBase
on(event: "reconnection_attempt_has_failed", eventHandler: (err: Error, message: string) => void): OPCUAClientBase
on(event: "after_reconnection", eventHandler: (err?: Error) => void): OPCUAClientBase
on(event: "abort", eventHandler: () => void): OPCUAClientBase
on(event: "close", eventHandler: () => void): OPCUAClientBase
on(event: "send_chunk", eventHandler: (chunk: Buffer) => void): OPCUAClientBase
on(event: "receive_chunk", eventHandler: (chunk: Buffer) => void): OPCUAClientBase
on(event: "send_request", eventHandler: (request: Request) => void): OPCUAClientBase
on(event: "receive_response", eventHandler: (response: Response) => void): OPCUAClientBase
on(event: "lifetime_75", eventHandler: (token: SecurityToken) => void): OPCUAClientBase
on(event: "security_token_renewed", eventHandler: () => void): OPCUAClientBase
on(event: "connection_lost", eventHandler: () => void): OPCUAClientBase
on(event: "connection_reestablished", eventHandler: () => void): OPCUAClientBase
on(event: "timed_out_request", eventHandler: (request: Request) => void): OPCUAClientBase
on(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

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

Parameters
- event: "connected"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:202
this Event is raised when the initial connection has failed

Parameters
- event: "connection_failed"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:209
this Event is raised when a failing connection is about to be tried again

Parameters
- event: "backoff"
- eventHandler: (count: number, delay: number) => void
  - - (count: number, delay: number): void
    - Parameters
      - count: number
      - delay: number
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:219
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: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:228
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: (err: Error, message: string) => void
  - - (err: Error, message: string): void
    - Parameters
      - err: Error
      - message: string
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:239
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: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:246
the event is raised when the connection has been aborted by the remote OPCUA Server

Parameters
- event: "abort"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:253
this event is raised when the connection is closed

Parameters
- event: "close"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:261
this event is raised when the client is sending a message chunk to the server (advanced use only)

Parameters
- event: "send_chunk"
- eventHandler: (chunk: Buffer) => void
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:269
this event is raised when the client has received a new message chunk from the servers (advanced use only)

Parameters
- event: "receive_chunk"
- eventHandler: (chunk: Buffer) => void
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:271
Parameters
- event: "send_request"
- eventHandler: (request: Request) => void
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:273
Parameters
- event: "receive_response"
- eventHandler: (response: Response) => void
  - - (response: Response): void
    - Parameters
      - response: Response
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:281
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: (token: SecurityToken) => void
  - - (token: SecurityToken): void
    - Parameters
      - token: SecurityToken
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:289
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: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:296
this event is raised when the connection has been broken

Parameters
- event: "connection_lost"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:303
this event is raised when a broken connection with the remote Server has been reestablished

Parameters
- event: "connection_reestablished"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:311
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: (request: Request) => void
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns OPCUAClientBase
- Defined in packages/node-opcua-client/source/client_base.ts:313
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

once

once(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

rawListeners

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

Inherited from OPCUASecureObject.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): OPCUAClientBase

Inherited from OPCUASecureObject.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns OPCUAClientBase

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): OPCUAClientBase

Inherited from OPCUASecureObject.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClientBase

setMaxListeners

setMaxListeners(n: number): OPCUAClientBase

Inherited from OPCUASecureObject.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns OPCUAClientBase

Static create

create(options: OPCUAClientBaseOptions): OPCUAClientBase

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

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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 registry

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns OPCUAClientBase

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 (string | symbol)[]

findEndpointForSecurity

Parameters

securityMode: MessageSecurityMode

securityPolicy: SecurityPolicy

Returns EndpointDescription

findServers

Parameters

Optional options: FindServersRequestOptions

Returns Promise<ApplicationDescription[]>

Parameters

options: FindServersRequestOptions

callback: ResponseCallback<ApplicationDescription[]>

Returns void

Parameters

callback: ResponseCallback<ApplicationDescription[]>

Returns void

findServersOnNetwork

Parameters

Optional options: FindServersOnNetworkRequestOptions