ClientSecureChannelLayer | NodeOPCUA reference documentation

a ClientSecureChannelLayer represents the client side of the OPCUA secure channel.

Hierarchy

EventEmitter
- ClientSecureChannelLayer

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ClientSecureChannelLayer(options: ClientSecureChannelLayerOptions): ClientSecureChannelLayer

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:122
Parameters
- options: ClientSecureChannelLayerOptions
Returns ClientSecureChannelLayer

Properties

channelId

channelId: number

endpointUrl

endpointUrl: string

protocolVersion

protocolVersion: number

Readonly securityMode

securityMode: MessageSecurityMode

Readonly securityPolicy

securityPolicy: SecurityPolicy

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultTransactionTimeout

defaultTransactionTimeout: number

Static defaultTransportTimeout

defaultTransportTimeout: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static minTransactionTimeout

minTransactionTimeout: number

Accessors

bytesRead

get bytesRead(): number

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:85
Returns number

bytesWritten

get bytesWritten(): number

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:86
Returns number

isConnecting

get isConnecting(): boolean

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:84
true if the secure channel is trying to establish the connection with the server. In this case, the client may be in the middle of the backoff connection process.

Returns boolean

timedOutRequestCount

get timedOutRequestCount(): number

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:88
Returns number

transactionsPerformed

get transactionsPerformed(): number

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:87
Returns number

Methods

abortConnection

abortConnection(callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:163
Parameters
- callback: ErrorCallback
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

cancelPendingTransactions

cancelPendingTransactions(callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:193
Parameters
- callback: ErrorCallback
Returns void

close

close(callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:204
Close a client SecureChannel ,by sending a CloseSecureChannelRequest to the server.

After this call, the connection is closed and no further transaction can be made.

method

close

async

Parameters
- callback: ErrorCallback
Returns void

closeWithError

closeWithError(err: Error, callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:205
Parameters
- err: Error
- callback: ErrorCallback
Returns void

create

create(endpointUrl: string, callback: ErrorCallback): void

establish a secure channel with the provided server end point.

method

create

async

example


var secureChannel  = new ClientSecureChannelLayer({});

secureChannel.on("end", function(err) {
     console.log("secure channel has ended",err);
     if(err) {
        console.log(" the connection was closed by an external cause such as server shutdown");
    }
});
secureChannel.create("opc.tcp://localhost:1234/UA/Sample", (err) => {
     if(err) {
          console.log(" cannot establish secure channel" , err);
     } else {
          console.log("secure channel has been established");
     }
});

Parameters

endpointUrl: string
callback: ErrorCallback

the async callback function

Returns void

dispose

dispose(): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:162
Returns void

emit

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

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getCertificate

getCertificate(): Buffer

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:126
Returns Buffer

getCertificateChain

getCertificateChain(): Buffer

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:125
Returns Buffer

getClientNonce

getClientNonce(): Buffer

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:129
Returns Buffer

getDisplayName

getDisplayName(): string

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:192
Returns string

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getPrivateKey

getPrivateKey(): string

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:124
Returns string

isOpened

isOpened(): boolean

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:191
Returns boolean

isTransactionInProgress

isTransactionInProgress(): boolean

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:128
Returns boolean

isValid

isValid(): boolean

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:190
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

on

on(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

once

once(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

performMessageTransaction

performMessageTransaction(request: Request, callback: PerformTransactionCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:189
perform a OPC-UA message transaction, asynchronously. During a transaction, the client sends a request to the server. The provided callback will be invoked at a later stage with the reply from the server, or the error.

preconditions:
- the channel must be opened
example
```
let secure_channel ; // get a  ClientSecureChannelLayer somehow

const request = new BrowseRequest({...});
secure_channel.performMessageTransaction(request, (err,response) => {
   if (err) {
     // an error has occurred
   } else {
      assert(response instanceof BrowseResponse);
     // do something with response.
   }
});
```
Parameters
- request: Request
- callback: PerformTransactionCallback
Returns void

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

rawListeners

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

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ClientSecureChannelLayer

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientSecureChannelLayer

setMaxListeners

setMaxListeners(n: number): ClientSecureChannelLayer

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ClientSecureChannelLayer

toString

toString(): string

- Defined in packages/node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:127
Returns string

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: ClientSecureChannelLayerOptions

Returns ClientSecureChannelLayer

Properties

channelId

endpointUrl

protocolVersion

Readonly securityMode

Readonly securityPolicy

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static defaultTransactionTimeout

Static defaultTransportTimeout

Readonly Static errorMonitor

Static minTransactionTimeout

Accessors

bytesRead

Returns number

bytesWritten

Returns number

isConnecting

Returns boolean

timedOutRequestCount

Returns number

transactionsPerformed

Returns number

Methods

abortConnection

Parameters

callback: ErrorCallback

Returns void

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientSecureChannelLayer

cancelPendingTransactions

Parameters

callback: ErrorCallback

Returns void

close

Parameters

callback: ErrorCallback

Returns void

closeWithError

Parameters

err: Error

callback: ErrorCallback

Returns void

create

Parameters

endpointUrl: string

callback: ErrorCallback

Returns void

dispose

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getCertificate

Returns Buffer

getCertificateChain

Returns Buffer