Class OPCUAClient

Hierarchy

OPCUAClientBase
- OPCUAClient

Implements

ICertificateKeyPairProvider

Implemented by

OPCUAClientImpl

Constructors

constructor

Constructors

constructor

new OPCUAClient(options: IOPCUASecureObjectOptions): OPCUAClient

Inherited from OPCUAClientBase.constructor
- Defined in packages/node-opcua-common/dist/opcua_secure_object.d.ts:26
Parameters
- options: IOPCUASecureObjectOptions
Returns OPCUAClient

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

Readonly tokenRenewalInterval

tokenRenewalInterval: number

Readonly transactionsPerformed

transactionsPerformed: number

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Methods

addListener

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

Inherited from UAStateVariable.addListener

Overrides 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/opcua_client.ts:151
Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
Returns Promise<void>
- Defined in packages/node-opcua-client/source/opcua_client.ts:156
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/opcua_client.ts:162
Parameters
- session: ClientSession
- deleteSubscriptions: boolean
Returns Promise<void>
- Defined in packages/node-opcua-client/source/opcua_client.ts:164
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

Overrides OPCUAClientBase.connect
- Defined in packages/node-opcua-client/source/opcua_client.ts:123
Parameters
- endpointUrl: string
Returns Promise<void>
Overrides OPCUAClientBase.connect
- Defined in packages/node-opcua-client/source/opcua_client.ts:125
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

createSession

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

- Defined in packages/node-opcua-client/source/opcua_client.ts:143
Parameters
- Optional userIdentityInfo: UserIdentityInfo
Returns Promise<ClientSession>
- Defined in packages/node-opcua-client/source/opcua_client.ts:145
Parameters
- userIdentityInfo: UserIdentityInfo
- callback: function
  - - (err: Error | null, session?: ClientSession): void
    - Parameters
      - err: Error | null
      - Optional session: ClientSession
      Returns void
Returns void
- Defined in packages/node-opcua-client/source/opcua_client.ts:149
Parameters
- callback: function
  - - (err: Error | null, session?: ClientSession): void
    - Parameters
      - err: Error | null
      - Optional session: ClientSession
      Returns void
Returns void

disconnect

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

Overrides OPCUAClientBase.disconnect
- Defined in packages/node-opcua-client/source/opcua_client.ts:127
Returns Promise<void>
Overrides OPCUAClientBase.disconnect
- Defined in packages/node-opcua-client/source/opcua_client.ts:129
Parameters
- callback: ErrorCallback
Returns void

emit

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

Inherited from UAStateVariable.emit

Overrides 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

Overrides UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

findEndpointForSecurity

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

Inherited from OPCUAClientBase.findEndpointForSecurity
- Defined in packages/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

Overrides OPCUAClientBase.findServers
- Defined in packages/node-opcua-client/source/opcua_client.ts:137
Parameters
- Optional options: FindServersRequestLike
Returns Promise<ApplicationDescription[]>
Overrides OPCUAClientBase.findServers
- Defined in packages/node-opcua-client/source/opcua_client.ts:139
Parameters
- options: FindServersRequestLike
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
Overrides OPCUAClientBase.findServers
- Defined in packages/node-opcua-client/source/opcua_client.ts:141
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 OPCUAClientBase.findServersOnNetwork
- Defined in packages/node-opcua-client/source/client_base.ts:164
Parameters
- Optional options: FindServersOnNetworkRequestLike
Returns Promise<ServerOnNetwork[]>
Inherited from OPCUAClientBase.findServersOnNetwork
- Defined in packages/node-opcua-client/source/client_base.ts:166
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
Inherited from OPCUAClientBase.findServersOnNetwork
- Defined in packages/node-opcua-client/source/client_base.ts:168
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

getEndpoints

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

Overrides OPCUAClientBase.getEndpoints
- Defined in packages/node-opcua-client/source/opcua_client.ts:131
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
Overrides OPCUAClientBase.getEndpoints
- Defined in packages/node-opcua-client/source/opcua_client.ts:133
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
Overrides OPCUAClientBase.getEndpoints
- Defined in packages/node-opcua-client/source/opcua_client.ts:135
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from UAStateVariable.getMaxListeners

Overrides 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

Overrides 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

Overrides 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

Overrides 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

Overrides OPCUAClientBase.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

Overrides 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

prependListener

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

Inherited from UAStateVariable.prependListener

Overrides 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

Overrides 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

Overrides 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/opcua_client.ts:166
Parameters
- session: ClientSession
Returns Promise<void>
- Defined in packages/node-opcua-client/source/opcua_client.ts:168
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

Overrides 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

Overrides 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

Overrides UAStateVariable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

withSession

withSession(endpointUrl: string | EndpointWithUserIdentity, inner_func: function, callback: function): void

- Defined in packages/node-opcua-client/source/opcua_client.ts:187
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<T>(endpointUrl: string | EndpointWithUserIdentity, inner_func: WithSessionFuncP<T>): Promise<T>

- Defined in packages/node-opcua-client/source/opcua_client.ts:182
Type parameters
- T
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- inner_func: WithSessionFuncP<T>
Returns Promise<T>

withSubscriptionAsync

withSubscriptionAsync<T>(endpointUrl: string | EndpointWithUserIdentity, parameters: ClientSubscriptionOptions, inner_func: WithSubscriptionFuncP<T>): Promise<T>

- Defined in packages/node-opcua-client/source/opcua_client.ts:191
Type parameters
- T
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- parameters: ClientSubscriptionOptions
- inner_func: WithSubscriptionFuncP<T>
Returns Promise<T>

Static create

create(options: OPCUAClientBaseOptions): OPCUAClientBase

Inherited from OPCUAClientBase.create
- Defined in packages/node-opcua-client/source/client_base.ts:327
Parameters
- options: OPCUAClientBaseOptions
Returns OPCUAClientBase

Class OPCUAClient

Hierarchy

Implements

Implemented by

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IOPCUASecureObjectOptions

Returns OPCUAClient

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

Parameters

Optional err: Error

Returns void

Returns void

closeSession

Parameters

session: ClientSession

deleteSubscriptions: boolean

Returns Promise<void>

Parameters

session: ClientSession

deleteSubscriptions: boolean

callback: function

Parameters

Optional err: Error

Returns void

Returns void

connect

Parameters

endpointUrl: string

Returns Promise<void>

Parameters

endpointUrl: string

callback: ErrorCallback

Returns void

createSession

Parameters