OPCUAClient | node-opcua-client

Hierarchy

OPCUAClientBase
- OPCUAClient

Implements

ICertificateKeyPairProvider

Implemented by

OPCUAClientImpl

Index

Constructors

constructor

Constructors

constructor

new OPCUAClient(options: IOPCUASecureObjectOptions): OPCUAClient

Inherited from OPCUASecureObject.__constructor
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:29
Parameters
- options: IOPCUASecureObjectOptions
Returns OPCUAClient

Properties

applicationName

applicationName: string

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

Optional endpoint

endpoint: EndpointDescription

endpointUrl

endpointUrl: string

isReconnecting

isReconnecting: boolean

keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

keepSessionAlive

keepSessionAlive: boolean

knowsServerEndpoint

knowsServerEndpoint: boolean

privateKeyFile

privateKeyFile: string

protocolVersion

protocolVersion: 0

reconnectOnFailure

reconnectOnFailure: boolean

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

Optional serverCertificate

serverCertificate: Certificate

tokenRenewalInterval

tokenRenewalInterval: number

transactionsPerformed

transactionsPerformed: number

Static defaultMaxListeners

defaultMaxListeners: number

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Methods

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

changeSessionIdentity

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

- Defined in node-opcua-client/source/opcua_client.ts:149
Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
Returns Promise<void>
- Defined in node-opcua-client/source/opcua_client.ts:154
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 node-opcua-client/source/opcua_client.ts:160
Parameters
- session: ClientSession
- deleteSubscriptions: boolean
Returns Promise<void>
- Defined in node-opcua-client/source/opcua_client.ts:162
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 node-opcua-client/source/opcua_client.ts:121
Parameters
- endpointUrl: string
Returns Promise<void>
Overrides OPCUAClientBase.connect
- Defined in node-opcua-client/source/opcua_client.ts:123
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 node-opcua-client/source/opcua_client.ts:141
Parameters
- Optional userIdentityInfo: UserIdentityInfo
Returns Promise<ClientSession>
- Defined in node-opcua-client/source/opcua_client.ts:143
Parameters
- userIdentityInfo: UserIdentityInfo
- callback: function
  - - (err: Error | null, session?: ClientSession): void
    - Parameters
      - err: Error | null
      - Optional session: ClientSession
      Returns void
Returns void
- Defined in node-opcua-client/source/opcua_client.ts:147
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 node-opcua-client/source/opcua_client.ts:125
Returns Promise<void>
Overrides OPCUAClientBase.disconnect
- Defined in node-opcua-client/source/opcua_client.ts:127
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>

findEndpointForSecurity

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

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

getEndpoints

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

Overrides OPCUAClientBase.getEndpoints
- Defined in node-opcua-client/source/opcua_client.ts:129
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
Overrides OPCUAClientBase.getEndpoints
- Defined in node-opcua-client/source/opcua_client.ts:131
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
Overrides OPCUAClientBase.getEndpoints
- Defined in node-opcua-client/source/opcua_client.ts:133
Parameters
- callback: ResponseCallback<EndpointDescription[]>
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

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[]

reactivateSession

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

- Defined in node-opcua-client/source/opcua_client.ts:164
Parameters
- session: ClientSession
Returns Promise<void>
- Defined in node-opcua-client/source/opcua_client.ts:166
Parameters
- session: ClientSession
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

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

withSession

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

- Defined in node-opcua-client/source/opcua_client.ts:173
Parameters
- endpointUrl: string
- 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, inner_func: function): Promise<T>

- Defined in node-opcua-client/source/opcua_client.ts:168
Type parameters
- T
Parameters
- endpointUrl: string
- inner_func: function
  - - (session: ClientSession): Promise<T>
    - Parameters
      - session: ClientSession
      Returns Promise<T>
Returns Promise<T>

Static create

create(options: OPCUAClientBaseOptions): OPCUAClientBase

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount

Overrides 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

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IOPCUASecureObjectOptions

Returns OPCUAClient

Properties

applicationName

bytesRead

bytesWritten

certificateFile

clientName

connectionStrategy

defaultSecureTokenLifetime

Optional endpoint

endpointUrl

isReconnecting

keepPendingSessionsOnDisconnect

keepSessionAlive

knowsServerEndpoint

privateKeyFile

protocolVersion

reconnectOnFailure

securityMode

securityPolicy

Optional serverCertificate

tokenRenewalInterval

transactionsPerformed

Static defaultMaxListeners

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