Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Optional applicationName

applicationName: string

the client application name

default

"NodeOPCUA-Client"

Optional applicationUri

applicationUri: string

the application Uri

default:

urn:${hostname}:${applicationName}

Optional certificateFile

certificateFile: string

client certificate pem file.

default

"certificates/client_self-signed_cert_2048.pem"

Optional clientCertificateManager

clientCertificateManager: OPCUACertificateManager

certificate Manager

Optional clientName

clientName: string

a client name string that will be used to generate session names.

Optional connectionStrategy

connectionStrategy: ConnectionStrategyOptions

Optional defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

default secure token lifetime in ms

Optional discoveryUrl

discoveryUrl: string

discovery url:

Optional endpointMustExist

endpointMustExist: boolean

set to false if the client should accept server endpoint mismatch

default

true

Optional endpoint_must_exist

endpoint_must_exist: boolean
deprecated(use

endpointMustExist instead)

Optional keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

if set to true, pending session will not be automatically closed when disconnect is called

Optional keepSessionAlive

keepSessionAlive: boolean
default

false

Optional privateKeyFile

privateKeyFile: string

client private key pem file.

default

"certificates/client_key_2048.pem"

Optional requestedSessionTimeout

requestedSessionTimeout: number

the requested session timeout in CreateSession (ms)

Note:

  • make sure that this value is large enough, especially larger than the time between two transactions to the server.

  • If your client establishes a subscription with the server, make sure that (maxKeepAliveCount * publishingInterval) calculated with negociated values from the server stay by large below the session time out, as you make encourtered unexpected behavior.

default

60000 - default value is 60 secondes

Optional securityMode

securityMode: string | Invalid | None | Sign | SignAndEncrypt

the security mode

default

MessageSecurityMode.None

Optional securityPolicy

securityPolicy: string

the security policy

default

SecurityPolicy.None

Optional serverCertificate

serverCertificate: Buffer

the server certificate.

Optional tokenRenewalInterval

tokenRenewalInterval: number

if not specify or set to 0 , token renewal will happen around 75% of the defaultSecureTokenLifetime

Generated using TypeDoc