Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OPCUAClientImpl

class

OPCUAClientImpl

extends

ClientBaseImpl

param
param

the default security mode.

param

the security mode.

param

the requested session time out in CreateSession

param

the client application name

param

set to false if the client should accept server endpoint mismatch

param
param

client certificate pem file.

param

client private key pem file.

param

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

constructor

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _secureChannel

_secureChannel: any

Protected _serverEndpoints

_serverEndpoints: EndpointDescription[]

_sessions

_sessions: any

applicationName

applicationName: string

certificateFile

certificateFile: string

clientName

clientName: string

connectionStrategy

connectionStrategy: ConnectionStrategy

defaultSecureTokenLifetime

defaultSecureTokenLifetime: number

discoveryUrl

discoveryUrl: string

Optional endpoint

endpoint: EndpointDescription

endpointUrl

endpointUrl: string

keepPendingSessionsOnDisconnect

keepPendingSessionsOnDisconnect: boolean

keepSessionAlive

keepSessionAlive: boolean

privateKeyFile

privateKeyFile: string

protocolVersion

protocolVersion: 0

securityMode

securityMode: MessageSecurityMode

securityPolicy

securityPolicy: SecurityPolicy

Optional serverCertificate

serverCertificate: Certificate

tokenRenewalInterval

tokenRenewalInterval: number

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

bytesRead

  • get bytesRead(): any

bytesWritten

  • get bytesWritten(): any

isReconnecting

  • get isReconnecting(): boolean

knowsServerEndpoint

  • get knowsServerEndpoint(): boolean

reconnectOnFailure

  • get reconnectOnFailure(): boolean

timedOutRequestCount

  • get timedOutRequestCount(): any

transactionsPerformed

  • get transactionsPerformed(): any

Methods

Private __createSession_step2

Private __createSession_step3

Private _activateSession

Protected _addSession

_cancel_reconnection

_internal_create_secure_channel

Private _on_connection_reestablished

  • _on_connection_reestablished(callback: function): void

_recreate_secure_channel

_removeSession

addListener

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

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

changeSessionIdentity

closeSession

  • closeSession(session: ClientSession, deleteSubscriptions: boolean): Promise<void>
  • closeSession(session: ClientSession, deleteSubscriptions: boolean, callback: function): void

connect

  • connect(endpointUrl: string): Promise<void>
  • connect(endpointUrl: string, callback: ErrorCallback): void

createSession

disconnect

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

emit

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

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

findEndpoint

  • findEndpoint(endpointUrl: string, securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined

findEndpointForSecurity

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

findServers

findServersOnNetwork

getCertificate

  • Returns Certificate

getCertificateChain

  • Returns Certificate

getClientNonce

  • getClientNonce(): Nonce

getEndpoints

getEndpointsRequest

  • getEndpointsRequest(options: any, callback: any): void

getMaxListeners

  • getMaxListeners(): number
  • Returns number

getPrivateKey

  • getPrivateKey(): PrivateKeyPEM
  • Returns PrivateKeyPEM

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • 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
  • 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
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

performMessageTransaction

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • 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
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

reactivateSession

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

toString

  • toString(): string

withSession

  • withSession<T>(endpointUrl: string, inner_func: function): Promise<T>
  • withSession(endpointUrl: string, inner_func: function, callback: function): void

withSessionAsync

  • withSessionAsync(endpointUrl: string, func: WithSessionFuncP<any>): Promise<any>

withSubscription

  • withSubscription(endpointUrl: string, subscriptionParameters: ClientSubscriptionOptions, innerFunc: function, callback: function): void

withSubscriptionAsync

  • withSubscriptionAsync(endpointUrl: string, parameters: any, func: WithSubscriptionFuncP<any>): Promise<any>

Static create

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc