Class ClientBaseImpl

internal

Hierarchy

OPCUASecureObject
- ClientBaseImpl
  - OPCUAClientImpl

Implements

ICertificateKeyPairProvider
OPCUAClientBase

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ClientBaseImpl(options?: OPCUAClientBaseOptions): ClientBaseImpl

Overrides OPCUAClientBase.constructor
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:313
Parameters
- Optional options: OPCUAClientBaseOptions
Returns ClientBaseImpl

Properties

_sessions

_sessions: any

Readonly applicationName

applicationName: string

Readonly certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

discoveryUrl

discoveryUrl: string

endpointUrl

endpointUrl: string

keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

keepSessionAlive

keepSessionAlive: boolean

Readonly privateKeyFile

privateKeyFile: string

protocolVersion

protocolVersion: 0

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

Optional serverCertificate

serverCertificate: Certificate

tokenRenewalInterval

tokenRenewalInterval: number

Accessors

bytesRead

get bytesRead(): number

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

property

bytesRead

Returns number

bytesWritten

get bytesWritten(): number

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

property

bytesWritten

Returns number

isReconnecting

get isReconnecting(): boolean

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

isReconnecting

Returns boolean

knowsServerEndpoint

get knowsServerEndpoint(): boolean

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

property

knowsServerEndpoint

Returns boolean

reconnectOnFailure

get reconnectOnFailure(): boolean

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

property

reconnectOnFailure

Returns boolean

timedOutRequestCount

get timedOutRequestCount(): number

- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:231
Returns number

transactionsPerformed

get transactionsPerformed(): number

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

property

transactionsPerformed

Returns number

Methods

_cancel_reconnection

_cancel_reconnection(callback: ErrorCallback): void

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

_internal_create_secure_channel

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

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

_on_connection_reestablished

_on_connection_reestablished(callback: ErrorCallback): void

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

_recreate_secure_channel

_recreate_secure_channel(callback: ErrorCallback): void

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

_removeSession

_removeSession(session: ClientSessionImpl): void

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

addListener

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

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

async

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

disconnect

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

- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:871
Returns Promise<void>
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:872
Parameters
- callback: ErrorCallback
Returns void

emit

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

Inherited from 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
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

findEndpoint

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

- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:727
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 packages/node-opcua-client/source/private/client_base_impl.ts:710
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 packages/node-opcua-client/source/private/client_base_impl.ts:791
method

findServers

Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:792
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:793
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/private/client_base_impl.ts:827
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:828
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:829
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

getClientNonce

getClientNonce(): Nonce | null

- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:688
Returns Nonce | null

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/private/client_base_impl.ts:745
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:746
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:747
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getEndpointsRequest

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

- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:783
Parameters
- options: any
- callback: any
Returns void

getMaxListeners

getMaxListeners(): number

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

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

once

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

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

performMessageTransaction

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

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

prependListener

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

Inherited from 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
- 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
- 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
- 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
- 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
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

toString

toString(): string

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

Generated using TypeDoc