OPCUAClient | NodeOPCUA reference documentation

Hierarchy

OPCUAClientBase
- OPCUAClient

Index

Constructors

constructor

Accessors

minimumRevisedSessionTimeout

Constructors

constructor

new OPCUAClient(): OPCUAClient

Inherited from OPCUAClientBase.constructor

Returns OPCUAClient

Properties

Readonly applicationName

applicationName: string

Readonly bytesRead

bytesRead: number

Readonly bytesWritten

bytesWritten: number

Readonly certificateFile

certificateFile: string

Readonly clientCertificateManager

clientCertificateManager: OPCUACertificateManager

certificate Manager

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

Readonly tokenRenewalInterval

tokenRenewalInterval: number

Readonly transactionsPerformed

transactionsPerformed: number

Accessors

Static minimumRevisedSessionTimeout

get minimumRevisedSessionTimeout(): number
set minimumRevisedSessionTimeout(minimumRevisedSessionTimeout: number): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:131
Returns number
- Defined in node-opcua-client/dist/opcua_client.d.ts:130
Parameters
- minimumRevisedSessionTimeout: number
Returns void

Methods

changeSessionIdentity

changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo): Promise<void>
changeSessionIdentity(session: ClientSession, userIdentityInfo: UserIdentityInfo, callback: (err?: Error) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:106
Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
Returns Promise<void>
- Defined in node-opcua-client/dist/opcua_client.d.ts:107
Parameters
- session: ClientSession
- userIdentityInfo: UserIdentityInfo
- callback: (err?: Error) => void
  - - (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: (err?: Error) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:108
Parameters
- session: ClientSession
- deleteSubscriptions: boolean
Returns Promise<void>
- Defined in node-opcua-client/dist/opcua_client.d.ts:109
Parameters
- session: ClientSession
- deleteSubscriptions: boolean
- callback: (err?: Error) => void
  - - (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/dist/opcua_client.d.ts:90
Parameters
- endpointUrl: string
Returns Promise<void>
Overrides OPCUAClientBase.connect
- Defined in node-opcua-client/dist/opcua_client.d.ts:91
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

createDefaultCertificate

createDefaultCertificate(): Promise<void>

- Defined in node-opcua-client/dist/opcua_client.d.ts:112
Returns Promise<void>

createSession

createSession(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>
createSession(userIdentityInfo: UserIdentityInfo, callback: (err: Error, session?: ClientSession) => void): void
createSession(callback: (err: Error, session?: ClientSession) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:100
Parameters
- Optional userIdentityInfo: UserIdentityInfo
Returns Promise<ClientSession>
- Defined in node-opcua-client/dist/opcua_client.d.ts:101
Parameters
- userIdentityInfo: UserIdentityInfo
- callback: (err: Error, session?: ClientSession) => void
  - - (err: Error, session?: ClientSession): void
    - Parameters
      - err: Error
      - Optional session: ClientSession
      Returns void
Returns void
- Defined in node-opcua-client/dist/opcua_client.d.ts:102
Parameters
- callback: (err: Error, session?: ClientSession) => void
  - - (err: Error, session?: ClientSession): void
    - Parameters
      - err: Error
      - Optional session: ClientSession
      Returns void
Returns void

createSession2

createSession2(userIdentityInfo?: UserIdentityInfo): Promise<ClientSession>
createSession2(userIdentityInfo: UserIdentityInfo, callback: (err: Error, session?: ClientSession) => void): void
createSession2(callback: (err: Error, session?: ClientSession) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:103
Parameters
- Optional userIdentityInfo: UserIdentityInfo
Returns Promise<ClientSession>
- Defined in node-opcua-client/dist/opcua_client.d.ts:104
Parameters
- userIdentityInfo: UserIdentityInfo
- callback: (err: Error, session?: ClientSession) => void
  - - (err: Error, session?: ClientSession): void
    - Parameters
      - err: Error
      - Optional session: ClientSession
      Returns void
Returns void
- Defined in node-opcua-client/dist/opcua_client.d.ts:105
Parameters
- callback: (err: Error, session?: ClientSession) => void
  - - (err: Error, session?: ClientSession): void
    - Parameters
      - err: Error
      - Optional session: ClientSession
      Returns void
Returns void

disconnect

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

Overrides OPCUAClientBase.disconnect
- Defined in node-opcua-client/dist/opcua_client.d.ts:92
causes client to close and disconnect the communication with server

Returns Promise<void>
Overrides OPCUAClientBase.disconnect
- Defined in node-opcua-client/dist/opcua_client.d.ts:93
Parameters
- callback: ErrorCallback
Returns void

findEndpointForSecurity

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

Inherited from OPCUAClientBase.findEndpointForSecurity
- Defined in node-opcua-client/source/client_base.ts:163
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns EndpointDescription

findServers

findServers(options?: FindServersRequestOptions): Promise<ApplicationDescription[]>
findServers(options: FindServersRequestOptions, callback: ResponseCallback<ApplicationDescription[]>): void
findServers(callback: ResponseCallback<ApplicationDescription[]>): void

Overrides OPCUAClientBase.findServers
- Defined in node-opcua-client/dist/opcua_client.d.ts:97
Parameters
- Optional options: FindServersRequestOptions
Returns Promise<ApplicationDescription[]>
Overrides OPCUAClientBase.findServers
- Defined in node-opcua-client/dist/opcua_client.d.ts:98
Parameters
- options: FindServersRequestOptions
- callback: ResponseCallback<ApplicationDescription[]>
Returns void
Overrides OPCUAClientBase.findServers
- Defined in node-opcua-client/dist/opcua_client.d.ts:99
Parameters
- callback: ResponseCallback<ApplicationDescription[]>
Returns void

findServersOnNetwork

findServersOnNetwork(options?: FindServersOnNetworkRequestOptions): Promise<ServerOnNetwork[]>
findServersOnNetwork(callback: ResponseCallback<ServerOnNetwork[]>): void
findServersOnNetwork(options: FindServersOnNetworkRequestOptions, callback: ResponseCallback<ServerOnNetwork[]>): void

Inherited from OPCUAClientBase.findServersOnNetwork
- Defined in node-opcua-client/source/client_base.ts:177
Parameters
- Optional options: FindServersOnNetworkRequestOptions
Returns Promise<ServerOnNetwork[]>
Inherited from OPCUAClientBase.findServersOnNetwork
- Defined in node-opcua-client/source/client_base.ts:179
Parameters
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void
Inherited from OPCUAClientBase.findServersOnNetwork
- Defined in node-opcua-client/source/client_base.ts:181
Parameters
- options: FindServersOnNetworkRequestOptions
- callback: ResponseCallback<ServerOnNetwork[]>
Returns void

getCertificate

getCertificate(): Buffer

Inherited from OPCUAClientBase.getCertificate
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:31
Returns Buffer

getCertificateChain

getCertificateChain(): Buffer

Inherited from OPCUAClientBase.getCertificateChain
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:32
Returns Buffer

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/dist/opcua_client.d.ts:94
Parameters
- Optional options: GetEndpointsOptions
Returns Promise<EndpointDescription[]>
Overrides OPCUAClientBase.getEndpoints
- Defined in node-opcua-client/dist/opcua_client.d.ts:95
Parameters
- options: GetEndpointsOptions
- callback: ResponseCallback<EndpointDescription[]>
Returns void
Overrides OPCUAClientBase.getEndpoints
- Defined in node-opcua-client/dist/opcua_client.d.ts:96
Parameters
- callback: ResponseCallback<EndpointDescription[]>
Returns void

getPrivateKey

getPrivateKey(): string

Inherited from OPCUAClientBase.getPrivateKey
- Defined in node-opcua-common/dist/opcua_secure_object.d.ts:33
Returns string

on

on(event: "connected", eventHandler: () => void): OPCUAClient
on(event: "connection_failed", eventHandler: (err: Error) => void): OPCUAClient
on(event: "backoff", eventHandler: (count: number, delay: number) => void): OPCUAClient
on(event: "start_reconnection", eventHandler: () => void): OPCUAClient
on(event: "reconnection_attempt_has_failed", eventHandler: (err: Error, message: string) => void): OPCUAClient
on(event: "after_reconnection", eventHandler: (err?: Error) => void): OPCUAClient
on(event: "abort", eventHandler: () => void): OPCUAClient
on(event: "close", eventHandler: () => void): OPCUAClient
on(event: "send_chunk", eventHandler: (chunk: Buffer) => void): OPCUAClient
on(event: "receive_chunk", eventHandler: (chunk: Buffer) => void): OPCUAClient
on(event: "send_request", eventHandler: (request: Request) => void): OPCUAClient
on(event: "receive_response", eventHandler: (response: Response) => void): OPCUAClient
on(event: "lifetime_75", eventHandler: (token: ChannelSecurityToken) => void): OPCUAClient
on(event: "security_token_renewed", eventHandler: () => void): OPCUAClient
on(event: "connection_lost", eventHandler: () => void): OPCUAClient
on(event: "connection_reestablished", eventHandler: () => void): OPCUAClient
on(event: "timed_out_request", eventHandler: (request: Request) => void): OPCUAClient
on(event: string | symbol, listener: (...args: any[]) => void): OPCUAClient

Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:193
this Event is raised when the initial connection has succeeded

Parameters
- event: "connected"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:200
this Event is raised when the initial connection has failed

Parameters
- event: "connection_failed"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:207
this Event is raised when a failing connection is about to be tried again

Parameters
- event: "backoff"
- eventHandler: (count: number, delay: number) => void
  - - (count: number, delay: number): void
    - Parameters
      - count: number
      - delay: number
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:217
this event is raised when the client has encountered a connection failure and and is going to reconnection mode. You can intercept start_reconnection event to pause your interaction with the remote OPCUA server.

Parameters
- event: "start_reconnection"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:226
this event is raised when the client has failed one attempt to reconnect to the server This event will be raised if the socket has successfully being created to the server but if something went wrong during the reconnection process.

Parameters
- event: "reconnection_attempt_has_failed"
- eventHandler: (err: Error, message: string) => void
  - - (err: Error, message: string): void
    - Parameters
      - err: Error
      - message: string
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:237
this event is raised after the client has successfully managed to re-establish the connection with the remote OPCUA Server. You can intercept after_reconnection event to resume your interaction with the remote OPCUA server.

Parameters
- event: "after_reconnection"
- eventHandler: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:244
the event is raised when the connection has been aborted by the remote OPCUA Server

Parameters
- event: "abort"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:251
this event is raised when the connection is closed

Parameters
- event: "close"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:259
this event is raised when the client is sending a message chunk to the server (advanced use only)

Parameters
- event: "send_chunk"
- eventHandler: (chunk: Buffer) => void
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:267
this event is raised when the client has received a new message chunk from the servers (advanced use only)

Parameters
- event: "receive_chunk"
- eventHandler: (chunk: Buffer) => void
  - - (chunk: Buffer): void
    - Parameters
      - chunk: Buffer
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:269
Parameters
- event: "send_request"
- eventHandler: (request: Request) => void
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:271
Parameters
- event: "receive_response"
- eventHandler: (response: Response) => void
  - - (response: Response): void
    - Parameters
      - response: Response
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:279
this event is raised when the current security token has reached 75% of its lifetime and is therefore about to expired.

Parameters
- event: "lifetime_75"
- eventHandler: (token: ChannelSecurityToken) => void
  - - (token: ChannelSecurityToken): void
    - Parameters
      - token: ChannelSecurityToken
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:287
this event is raised after the (about ) security token as been renewed and renegotiated with the server.to expire

Parameters
- event: "security_token_renewed"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:294
this event is raised when the connection has been broken

Parameters
- event: "connection_lost"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:301
this event is raised when a broken connection with the remote Server has been reestablished

Parameters
- event: "connection_reestablished"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:309
This event is raised when a request sent to the remote OPCUA server has reach it's timeout value without a Response from the server.

Parameters
- event: "timed_out_request"
- eventHandler: (request: Request) => void
  - - (request: Request): void
    - Parameters
      - request: Request
      Returns void
Returns OPCUAClient
Inherited from OPCUAClientBase.on
- Defined in node-opcua-client/source/client_base.ts:311
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns OPCUAClient

reactivateSession

reactivateSession(session: ClientSession): Promise<void>
reactivateSession(session: ClientSession, callback: (err?: Error) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:110
Parameters
- session: ClientSession
Returns Promise<void>
- Defined in node-opcua-client/dist/opcua_client.d.ts:111
Parameters
- session: ClientSession
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

withSession

withSession(endpointUrl: string | EndpointWithUserIdentity, inner_func: (session: ClientSession, done: (err?: Error) => void) => void, callback: (err?: Error) => void): void

- Defined in node-opcua-client/dist/opcua_client.d.ts:124
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- inner_func: (session: ClientSession, done: (err?: Error) => void) => void
  - - (session: ClientSession, done: (err?: Error) => void): void
    - Parameters
      - session: ClientSession
      - done: (err?: Error) => void
        
        (err?: Error): void
        
        Parameters
        
        Optional err: Error
        
        Returns void
      Returns void
- callback: (err?: Error) => void
  - - (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 node-opcua-client/dist/opcua_client.d.ts:123
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 node-opcua-client/dist/opcua_client.d.ts:125
Type parameters
- T
Parameters
- endpointUrl: string | EndpointWithUserIdentity
- parameters: ClientSubscriptionOptions
- inner_func: WithSubscriptionFuncP<T>
Returns Promise<T>

Static create

create(options: OPCUAClientOptions): OPCUAClient

Inherited from OPCUAClientBase.create
- Defined in node-opcua-client/dist/opcua_client.d.ts:128
Parameters
- options: OPCUAClientOptions
Returns OPCUAClient

Static createSession

createSession(endpointUrl: string, userIdentity?: UserIdentityInfo, clientOptions?: OPCUAClientOptions): Promise<ClientSession>

- Defined in node-opcua-client/dist/opcua_client.d.ts:129
Parameters
- endpointUrl: string
- Optional userIdentity: UserIdentityInfo
- Optional clientOptions: OPCUAClientOptions
Returns Promise<ClientSession>

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns OPCUAClient

Properties

Readonly applicationName

Readonly bytesRead

Readonly bytesWritten

Readonly certificateFile

Readonly clientCertificateManager

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

Accessors

Static minimumRevisedSessionTimeout

Returns number

Parameters

minimumRevisedSessionTimeout: number

Returns void

Methods

changeSessionIdentity

Parameters

session: ClientSession

userIdentityInfo: UserIdentityInfo

Returns Promise<void>

Parameters

session: ClientSession

userIdentityInfo: UserIdentityInfo

callback: (err?: Error) => void

Parameters

Optional err: Error

Returns void

Returns void

closeSession

Parameters

session: ClientSession

deleteSubscriptions: boolean

Returns Promise<void>

Parameters

session: ClientSession

deleteSubscriptions: boolean

callback: (err?: Error) => void

Parameters

Optional err: Error

Returns void

Returns void

connect

Parameters

endpointUrl: string

Returns Promise<void>

Parameters

endpointUrl: string

callback: ErrorCallback

Returns void

createDefaultCertificate

Returns Promise<void>

createSession

Parameters

Optional userIdentityInfo: UserIdentityInfo

Returns Promise<ClientSession>