ClientBaseImpl | node-opcua-client

Hierarchy

OPCUASecureObject
- ClientBaseImpl
  - OPCUAClientImpl

Implements

ICertificateKeyPairProvider
OPCUAClientBase

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ClientBaseImpl(options?: OPCUAClientBaseOptions): ClientBaseImpl

Overrides OPCUASecureObject.__constructor
- Defined in node-opcua-client/source/private/client_base_impl.ts:290
Parameters
- Optional options: OPCUAClientBaseOptions
Returns ClientBaseImpl

Properties

Protected _secureChannel

_secureChannel: any

Protected _serverEndpoints

_serverEndpoints: EndpointDescription[]

_sessions

_sessions: any

applicationName

applicationName: string

certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

discoveryUrl

discoveryUrl: string

endpointUrl

endpointUrl: string

keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

keepSessionAlive

keepSessionAlive: boolean

privateKeyFile

privateKeyFile: string

protocolVersion

protocolVersion: 0

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

Optional serverCertificate

serverCertificate: Certificate

tokenRenewalInterval

tokenRenewalInterval: number

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

bytesRead

get bytesRead(): any

- Defined in node-opcua-client/source/private/client_base_impl.ts:252
total number of bytes read by the client

property

bytesRead

type

{Number}

Returns any

bytesWritten

get bytesWritten(): any

- Defined in node-opcua-client/source/private/client_base_impl.ts:261
total number of bytes written by the client

property

bytesWritten

type

{Number}

Returns any

isReconnecting

get isReconnecting(): boolean

- Defined in node-opcua-client/source/private/client_base_impl.ts:234
property

isReconnecting

type

{Boolean} true if the client is trying to reconnect to the server after a connection break.

Returns boolean

knowsServerEndpoint

get knowsServerEndpoint(): boolean

- Defined in node-opcua-client/source/private/client_base_impl.ts:226
is true when the client has already requested the server end points.

property

knowsServerEndpoint

type

boolean

Returns boolean

reconnectOnFailure

get reconnectOnFailure(): boolean

- Defined in node-opcua-client/source/private/client_base_impl.ts:243
true if the connection strategy is set to automatically try to reconnect in case of failure

property

reconnectOnFailure

type

{Boolean}

Returns boolean

timedOutRequestCount

get timedOutRequestCount(): any

- Defined in node-opcua-client/source/private/client_base_impl.ts:208
Returns any

transactionsPerformed

get transactionsPerformed(): any

- Defined in node-opcua-client/source/private/client_base_impl.ts:217
total number of transactions performed by the client

property

transactionsPerformed

type

{Number}

Returns any

Methods

Protected _addSession

_addSession(session: ClientSessionImpl): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:935
Parameters
- session: ClientSessionImpl
Returns void

_cancel_reconnection

_cancel_reconnection(callback: ErrorCallback): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:377
Parameters
- callback: ErrorCallback
Returns void

_internal_create_secure_channel

_internal_create_secure_channel(connectionStrategy: ConnectionStrategyOptions, callback: CreateSecureChannelCallbackFunc): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:500
Parameters
- connectionStrategy: ConnectionStrategyOptions
- callback: CreateSecureChannelCallbackFunc
Returns void

_on_connection_reestablished

_on_connection_reestablished(callback: ErrorCallback): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:910
Parameters
- callback: ErrorCallback
Returns void

_recreate_secure_channel

_recreate_secure_channel(callback: ErrorCallback): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:395
Parameters
- callback: ErrorCallback
Returns void

_removeSession

_removeSession(session: ClientSessionImpl): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:827
Parameters
- session: ClientSessionImpl
Returns void

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/private/client_base_impl.ts:590
connect the OPC-UA client to a server end point.

async

Parameters
- endpointUrl: string
Returns Promise<void>
- Defined in node-opcua-client/source/private/client_base_impl.ts:591
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

disconnect

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

- Defined in node-opcua-client/source/private/client_base_impl.ts:841
Returns Promise<void>
- Defined in node-opcua-client/source/private/client_base_impl.ts:842
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>

findEndpoint

findEndpoint(endpointUrl: string, securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined

- Defined in node-opcua-client/source/private/client_base_impl.ts:694
return the endpoint information matching the specified url , security mode and security policy.

method

findEndpoint

Parameters
- endpointUrl: string
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns EndpointDescription | undefined

findEndpointForSecurity

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

- Defined in node-opcua-client/source/private/client_base_impl.ts:676
return the endpoint information matching security mode and security policy.

method

findEndpoint

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/private/client_base_impl.ts:757
method

findServers

Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
- Defined in node-opcua-client/source/private/client_base_impl.ts:758
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
- Defined in node-opcua-client/source/private/client_base_impl.ts:759
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/private/client_base_impl.ts:794
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
- Defined in node-opcua-client/source/private/client_base_impl.ts:795
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
- Defined in node-opcua-client/source/private/client_base_impl.ts:796
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

getClientNonce

getClientNonce(): Nonce

- Defined in node-opcua-client/source/private/client_base_impl.ts:653
Returns Nonce

getEndpoints

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

- Defined in node-opcua-client/source/private/client_base_impl.ts:711
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
- Defined in node-opcua-client/source/private/client_base_impl.ts:712
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
- Defined in node-opcua-client/source/private/client_base_impl.ts:713
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getEndpointsRequest

getEndpointsRequest(options: any, callback: any): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:749
Parameters
- options: any
- callback: any
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

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

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

performMessageTransaction

performMessageTransaction(request: Request, callback: ResponseCallback<Response>): void

- Defined in node-opcua-client/source/private/client_base_impl.ts:657
Parameters
- request: Request
- callback: ResponseCallback<Response>
Returns void

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

toString

toString(): string

- Defined in node-opcua-client/source/private/client_base_impl.ts:914
Returns string

Static listenerCount

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

Inherited from 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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: OPCUAClientBaseOptions

Returns ClientBaseImpl

Properties

Protected _secureChannel

Protected _serverEndpoints

_sessions

applicationName

certificateFile

clientName

connectionStrategy

defaultSecureTokenLifetime

discoveryUrl

endpointUrl

keepPendingSessionsOnDisconnect

keepSessionAlive

privateKeyFile

protocolVersion

securityMode

securityPolicy

Optional serverCertificate

tokenRenewalInterval

Static defaultMaxListeners

Accessors

bytesRead

Returns any

bytesWritten

Returns any

isReconnecting

Returns boolean

knowsServerEndpoint

Returns boolean

reconnectOnFailure

Returns boolean

timedOutRequestCount

Returns any

transactionsPerformed

Returns any

Methods

Protected _addSession

Parameters

session: ClientSessionImpl

Returns void

_cancel_reconnection

Parameters

callback: ErrorCallback

Returns void

_internal_create_secure_channel

Parameters

connectionStrategy: ConnectionStrategyOptions

callback: CreateSecureChannelCallbackFunc

Returns void

_on_connection_reestablished

Parameters

callback: ErrorCallback

Returns void

_recreate_secure_channel

Parameters

callback: ErrorCallback

Returns void

_removeSession

Parameters

session: ClientSessionImpl

Returns void

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void