Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientBaseEx

Hierarchy

  • OPCUAClientBase
    • ClientBaseEx

Implements

  • ICertificateKeyPairProvider

Constructors

Properties

Methods

Constructors

constructor

  • new ClientBaseEx(options: IOPCUASecureObjectOptions): ClientBaseEx

Properties

_serverEndpoints

_serverEndpoints: EndpointDescription[]

Readonly applicationName

applicationName: string

Readonly bytesRead

bytesRead: number

Readonly bytesWritten

bytesWritten: number

Readonly certificateFile

certificateFile: string

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

Readonly tokenRenewalInterval

tokenRenewalInterval: number

Readonly transactionsPerformed

transactionsPerformed: number

Static registry

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

connect

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

  • Parameters

    • endpointUrl: string

      the endpoint of the server to connect to ( i.e "opc.tcp://machine.name:3434/name" )

    Returns Promise<void>

  • Parameters

    Returns void

disconnect

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

  • causes client to close and disconnect the communication with server

    Returns Promise<void>

  • Parameters

    Returns void

emit

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

eventNames

  • eventNames(): Array<string | symbol>

findEndpointForSecurity

findServers

findServersOnNetwork

getCertificate

getCertificateChain

getEndpoints

  • getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>
  • getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void
  • getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void

  • Parameters

    • Optional options: GetEndpointsOptions

    Returns Promise<EndpointDescription[]>

  • Parameters

    • options: GetEndpointsOptions
    • callback: ResponseCallback<EndpointDescription[]>

    Returns void

  • Parameters

    Returns void

getMaxListeners

  • getMaxListeners(): number

getPrivateKey

  • getPrivateKey(): PrivateKeyPEM

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): 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

performMessageTransaction

  • performMessageTransaction(request: RegisterServer2Request, callback: ResponseCallback<RegisterServer2Response>): void
  • performMessageTransaction(request: RegisterServerRequest, callback: ResponseCallback<RegisterServerResponse>): void

  • Parameters

    • request: RegisterServer2Request
    • callback: ResponseCallback<RegisterServer2Response>

    Returns void

  • Parameters

    • request: RegisterServerRequest
    • callback: ResponseCallback<RegisterServerResponse>

    Returns void

prependListener

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

prependOnceListener

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

rawListeners

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

removeAllListeners

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

removeListener

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

setMaxListeners

  • setMaxListeners(n: number): this

Static create

  • create(options: OPCUAClientBaseOptions): OPCUAClientBase

  • Parameters

    • options: OPCUAClientBaseOptions

    Returns OPCUAClientBase

Generated using TypeDoc