Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OPCUAClient

Hierarchy

Implements

  • ICertificateKeyPairProvider

Implemented by

Index

Constructors

constructor

  • new OPCUAClient(options: IOPCUASecureObjectOptions): OPCUAClient
  • 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
  • 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>

findEndpointForSecurity

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

findServers

findServersOnNetwork

getCertificate

  • Returns Certificate

getCertificateChain

  • Returns Certificate

getEndpoints

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

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

withSession

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

    • endpointUrl: string
    • inner_func: function
        • 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>

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