Class OPCUAClientImpl

param
param: the default security mode.
param: the security mode.
param: the requested session time out in CreateSession
param: the client application name
param: set to false if the client should accept server endpoint mismatch
param
param: client certificate pem file.
param: client private key pem file.
param: a client name string that will be used to generate session names.
internal

Hierarchy

ClientBaseImpl
- OPCUAClientImpl

Implements

ICertificateKeyPairProvider
OPCUAClientBase
OPCUAClient

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OPCUAClientImpl(options?: OPCUAClientOptions): OPCUAClientImpl

Overrides ClientBaseImpl.constructor
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:344
Parameters
- Optional options: OPCUAClientOptions
Returns OPCUAClientImpl

Properties

_sessions

_sessions: any

Readonly applicationName

applicationName: string

Readonly certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

discoveryUrl

discoveryUrl: string

Optional endpoint

endpoint: EndpointDescription

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

Inherited from ClientBaseImpl.bytesRead
- 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

Inherited from ClientBaseImpl.bytesWritten
- 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

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

isReconnecting

Returns boolean

knowsServerEndpoint

get knowsServerEndpoint(): boolean

Inherited from ClientBaseImpl.knowsServerEndpoint
- 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

Inherited from ClientBaseImpl.reconnectOnFailure
- 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

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

transactionsPerformed

get transactionsPerformed(): number

Inherited from ClientBaseImpl.transactionsPerformed
- 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

Inherited from ClientBaseImpl._cancel_reconnection
- 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

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

_recreate_secure_channel

_recreate_secure_channel(callback: ErrorCallback): void

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

_removeSession

_removeSession(session: ClientSessionImpl): void

Inherited from ClientBaseImpl._removeSession
- 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

changeSessionIdentity

changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<void>
changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: function): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:425
method

changeSessionIdentity

async

Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
Returns Promise<void>
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:426
internal

Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

closeSession

closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>
closeSession(session: ClientSession, deleteSubscriptions: boolean, callback: function): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:453
method

closeSession

async

Parameters
- session: ClientSession
  
  the created client session
- deleteSubscriptions: boolean
  
  whether to delete subscriptions or not
Returns Promise<void>
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:454
internals

Parameters
- session: ClientSession
- deleteSubscriptions: boolean
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

connect

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

Inherited from ClientBaseImpl.connect
- 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>
Inherited from ClientBaseImpl.connect
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:600
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

createSession

createSession(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>
createSession(userIdentityInfo: UserIdentityInfo, callback: Callback<ClientSession>): void
createSession(callback: Callback<ClientSession>): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:382
create and activate a new session

async

method

createSession

example

: // create a anonymous session client.createSession(function(err,session) { if (err) {} else {} });

example

: // create a session with a userName and password client.createSession({userName: "JoeDoe", password:"secret"}, function(err,session) { if (err) {} else {} });

Parameters
- Optional userIdentityInfo: UserIdentityInfo
Returns Promise<ClientSession>
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:383
internal

Parameters
- userIdentityInfo: UserIdentityInfo
- callback: Callback<ClientSession>
Returns void
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:384
internal

Parameters
- callback: Callback<ClientSession>
Returns void

disconnect

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

Inherited from ClientBaseImpl.disconnect
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:871
Returns Promise<void>
Inherited from ClientBaseImpl.disconnect
- 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

Inherited from ClientBaseImpl.findEndpoint
- 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

Inherited from ClientBaseImpl.findEndpointForSecurity
- 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

Inherited from ClientBaseImpl.findServers
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:791
method

findServers

Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
Inherited from ClientBaseImpl.findServers
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:792
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
Inherited from ClientBaseImpl.findServers
- 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

Inherited from ClientBaseImpl.findServersOnNetwork
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:827
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
Inherited from ClientBaseImpl.findServersOnNetwork
- Defined in packages/node-opcua-client/source/private/client_base_impl.ts:828
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
Inherited from ClientBaseImpl.findServersOnNetwork
- 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

Inherited from ClientBaseImpl.getClientNonce
- 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

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

Inherited from ClientBaseImpl.getEndpointsRequest
- 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

Inherited from ClientBaseImpl.performMessageTransaction
- 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[]

reactivateSession

reactivateSession(session: ClientSession): Promise<void>
reactivateSession(session: ClientSession, callback: function): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:703
transfer session to this client

method

reactivateSession

Parameters
- session: ClientSession
Returns Promise<void>
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:704
Parameters
- session: ClientSession
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

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

Overrides ClientBaseImpl.toString
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:484
Returns string

withSession

withSession<T>(endpointUrl: string | EndpointWithUserIdentity, inner_func: function): Promise<T>
withSession(endpointUrl: string | EndpointWithUserIdentity, inner_func: function, callback: function): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:495
method

withSession

Type parameters
- T
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- inner_func: function
  - - (session: ClientSession): Promise<T>
    - Parameters
      - session: ClientSession
      Returns Promise<T>
Returns Promise<T>
- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:500
internal

Parameters
- endpointUrl: string | EndpointWithUserIdentity
- inner_func: function
  - - (session: ClientSession, done: function): void
    - Parameters
      - session: ClientSession
      - done: function
        
        (err?: Error): void
        
        Parameters
        
        Optional err: Error
        
        Returns void
      Returns void
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

withSessionAsync

withSessionAsync(connectionPoint: string | EndpointWithUserIdentity, func: WithSessionFuncP<any>): Promise<any>

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:636
Parameters
- connectionPoint: string | EndpointWithUserIdentity
- func: WithSessionFuncP<any>
Returns Promise<any>

withSubscription

withSubscription(endpointUrl: string | EndpointWithUserIdentity, subscriptionParameters: ClientSubscriptionOptions, innerFunc: function, callback: function): void

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:605
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- subscriptionParameters: ClientSubscriptionOptions
- innerFunc: function
  - - (session: ClientSession, subscription: ClientSubscription, done: function): void
    - Parameters
      - session: ClientSession
      - subscription: ClientSubscription
      - done: function
        
        (err?: Error): void
        
        Parameters
        
        Optional err: Error
        
        Returns void
      Returns void
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

withSubscriptionAsync

withSubscriptionAsync(connectionPoint: string | EndpointWithUserIdentity, parameters: ClientSubscriptionOptions, func: WithSubscriptionFuncP<any>): Promise<any>

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:664
Parameters
- connectionPoint: string | EndpointWithUserIdentity
- parameters: ClientSubscriptionOptions
- func: WithSubscriptionFuncP<any>
Returns Promise<any>

Static create

create(options: OPCUAClientOptions): OPCUAClient

- Defined in packages/node-opcua-client/source/private/opcua_client_impl.ts:333
Parameters
- options: OPCUAClientOptions
Returns OPCUAClient

Class OPCUAClientImpl

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: OPCUAClientOptions

Returns OPCUAClientImpl

Properties

_sessions

Readonly applicationName

Readonly certificateFile

clientName

connectionStrategy

defaultSecureTokenLifetime

discoveryUrl

Optional endpoint

endpointUrl

keepPendingSessionsOnDisconnect

keepSessionAlive

Readonly privateKeyFile

protocolVersion

securityMode

securityPolicy

Optional serverCertificate

tokenRenewalInterval

Accessors

bytesRead

Returns number

bytesWritten

Returns number

isReconnecting

Returns boolean

knowsServerEndpoint

Returns boolean

reconnectOnFailure

Returns boolean

timedOutRequestCount

Returns number

transactionsPerformed

Returns number

Methods

_cancel_reconnection

Parameters

callback: ErrorCallback

Returns void

_internal_create_secure_channel

Parameters

connectionStrategy: ConnectionStrategyOptions

callback: CreateSecureChannelCallbackFunc

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

Returns this

changeSessionIdentity

Parameters

session: ClientSession

userIdentityInfo: UserIdentityInfo

Returns Promise<void>

Parameters

session: ClientSession

userIdentityInfo: UserIdentityInfo

callback: function