Interface OPCUAClientBaseOptions

interface OPCUAClientBaseOptions {
    applicationName?: string;
    applicationUri?: string;
    certificateFile?: string;
    clientCertificateManager?: OPCUACertificateManager;
    clientName?: string;
    connectionStrategy?: ConnectionStrategyOptions;
    defaultSecureTokenLifetime?: number;
    defaultTransactionTimeout?: number;
    discoveryUrl?: string;
    keepAliveInterval?: number;
    keepPendingSessionsOnDisconnect?: boolean;
    keepSessionAlive?: boolean;
    privateKeyFile?: string;
    securityMode?: string | MessageSecurityMode;
    securityPolicy?: string;
    serverCertificate?: Buffer;
    tokenRenewalInterval?: number;
    transportSettings?: TransportSettings;
    transportTimeout?: number;
}

Hierarchy (view full)

Properties

applicationName? applicationUri? certificateFile? clientCertificateManager? clientName? connectionStrategy? defaultSecureTokenLifetime? defaultTransactionTimeout? discoveryUrl? keepAliveInterval? keepPendingSessionsOnDisconnect? keepSessionAlive? privateKeyFile? securityMode? securityPolicy? serverCertificate? tokenRenewalInterval? transportSettings? transportTimeout?

Properties

OptionalapplicationName

applicationName?: string

the client application name

Default

"NodeOPCUA-Client"

OptionalapplicationUri

applicationUri?: string

the application Uri @default: urn:${hostname}:${applicationName}

OptionalcertificateFile

certificateFile?: string

client certificate pem file.

Default

`${clientCertificateManager/rootFolder}/own/certs/client_certificate.pem"

OptionalclientCertificateManager

clientCertificateManager?: OPCUACertificateManager

certificate Manager

OptionalclientName

clientName?: string

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

OptionalconnectionStrategy

connectionStrategy?: ConnectionStrategyOptions

OptionaldefaultSecureTokenLifetime

defaultSecureTokenLifetime?: number

default secure token lifetime in ms

OptionaldefaultTransactionTimeout

defaultTransactionTimeout?: number

defaultTransactionTimeout

OptionaldiscoveryUrl

discoveryUrl?: string

discovery url:

OptionalkeepAliveInterval

keepAliveInterval?: number

the number of milliseconds that the client should wait until it sends a keep alive message to the server.

OptionalkeepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect?: boolean

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

OptionalkeepSessionAlive

keepSessionAlive?: boolean

can be set when the client doesn't create subscription. In this case, the client will send a dummy request on a regular basis to keep the connection active.

Default

false

OptionalprivateKeyFile

privateKeyFile?: string

client private key pem file.

Default

`${clientCertificateManager/rootFolder}/own/private/private_key.pem"

OptionalsecurityMode

securityMode?: string | MessageSecurityMode

the security mode

Default

MessageSecurityMode.None

OptionalsecurityPolicy

securityPolicy?: string

the security policy

Default

SecurityPolicy.None

OptionalserverCertificate

serverCertificate?: Buffer

the server certificate.

OptionaltokenRenewalInterval

tokenRenewalInterval?: number

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

OptionaltransportSettings

transportSettings?: TransportSettings

specify some transport settings that will override the default transport settings for the end point.

OptionaltransportTimeout

transportTimeout?: number

transport timeout

Settings

Member Visibility

On This Page

Properties