Class ServerSecureChannelLayer

uses: MessageBuilder
uses: MessageChunker

Hierarchy

EventEmitter
- ServerSecureChannelLayer

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ServerSecureChannelLayer(options: SeverSecureChannelLayerOptions): ServerSecureChannelLayer

Overrides ClientMonitoredItemBase.constructor
- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:349
Parameters
- options: SeverSecureChannelLayerOptions
Returns ServerSecureChannelLayer

Properties

_on_response

_on_response: function | null

channelId

channelId: number | null

clientCertificate

clientCertificate: Buffer | null

clientNonce

clientNonce: Buffer | null

Optional clientSecurityHeader

clientSecurityHeader: SecurityHeader

Readonly messageBuilder

messageBuilder: MessageBuilder

receiverCertificate

receiverCertificate: Buffer | null

securityHeader

securityHeader: AsymmetricAlgorithmSecurityHeader | null

securityMode

securityMode: MessageSecurityMode

the channel message security mode

securityPolicy

securityPolicy: SecurityPolicy = SecurityPolicy.Invalid

the channel message security policy

sessionTokens

sessionTokens: any

timeout

timeout: number

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

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 registry

registry: any

Static throttleTime

throttleTime: number = 100

Accessors

aborted

get aborted(): boolean

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:248
Returns boolean

bytesRead

get bytesRead(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:255
the number of bytes read so far by this channel

Returns number

bytesWritten

get bytesWritten(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:262
the number of bytes written so far by this channel

Returns number

certificateManager

get certificateManager(): ICertificateManager

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:285
Returns ICertificateManager

hasSession

get hasSession(): boolean

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:281
true when the secure channel is assigned to a active session

Returns boolean

hashKey

get hashKey(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:293
The unique hash key to identify this secure channel

property

hashKey

Returns number

isOpened

get isOpened(): boolean

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:274
true when the secure channel has been opened successfully

Returns boolean

remoteAddress

get remoteAddress(): string

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:237
Returns string

remotePort

get remotePort(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:241
Returns number

securityTokenCount

get securityTokenCount(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:232
Returns number

transactionsCount

get transactionsCount(): number

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:266
Returns number

Methods

_rememberClientAddressAndPort

_rememberClientAddressAndPort(): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:707
Returns void

abruptlyInterrupt

abruptlyInterrupt(): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:480
Returns void

addListener

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

Inherited from UAStateVariable.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(callback?: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:682
Abruptly close a Server SecureChannel ,by terminating the underlying transport.

method

close

async

Parameters
- Optional callback: ErrorCallback
Returns void

dispose

dispose(): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:446
Returns void

emit

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

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

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:523
method

getCertificate

Returns Certificate

the X509 DER form certificate

getCertificateChain

getCertificateChain(): Certificate

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:512
method

getCertificateChain

Returns Certificate

the X509 DER form certificate

getEndpointDescription

getEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, endpointUri: string | null): EndpointDescription | null

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:492
the endpoint associated with this secure channel

Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
- endpointUri: string | null
Returns EndpointDescription | null

getMaxListeners

getMaxListeners(): number

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

getPrivateKey

getPrivateKey(): PrivateKeyPEM

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:541
method

getPrivateKey

Returns PrivateKeyPEM

the privateKey

getSignatureLength

getSignatureLength(): PublicKeyLength

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:530
Returns PublicKeyLength

has_endpoint_for_security_mode_and_policy

has_endpoint_for_security_mode_and_policy(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): boolean

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:699
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns boolean

init

init(socket: Socket, callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:555
method

init

async

Parameters
- socket: Socket
- callback: ErrorCallback
Returns void

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

off

off(event: string | symbol, listener: function): this

Inherited from UAStateVariable.off
- Defined in node_modules/@types/node/events.d.ts:66
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

Inherited from NonHierarchicalReferences.on
- Defined in node_modules/@types/node/events.d.ts:63
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

Inherited from NonHierarchicalReferences.once
- Defined in node_modules/@types/node/events.d.ts:64
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

Inherited from UAStateVariable.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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

Inherited from UAStateVariable.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from UAStateVariable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from UAStateVariable.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send_fatal_error_and_abort

send_fatal_error_and_abort(statusCode: StatusCode, description: string, message: Message, callback: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:666
Parameters
- statusCode: StatusCode
- description: string
- message: Message
- callback: ErrorCallback
Returns void

send_response

send_response(msgType: string, response: Response, message: Message, callback?: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:595
method

send_response

async

Parameters
- msgType: string
- response: Response
- message: Message
- Optional callback: ErrorCallback
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from UAStateVariable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setSecurity

setSecurity(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): void

- Defined in packages/node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:503
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns void

Static listenerCount

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

Inherited from ConditionSnapshot.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

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

Class ServerSecureChannelLayer

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: SeverSecureChannelLayerOptions

Returns ServerSecureChannelLayer

Properties

_on_response

channelId

clientCertificate

clientNonce

Optional clientSecurityHeader

Readonly messageBuilder

receiverCertificate

securityHeader

securityMode

securityPolicy

sessionTokens

timeout

Static defaultMaxListeners

Static Readonly errorMonitor

Static registry

Static throttleTime

Accessors

aborted

Returns boolean

bytesRead

Returns number

bytesWritten

Returns number

certificateManager

Returns ICertificateManager

hasSession

Returns boolean

hashKey

Returns number

isOpened

Returns boolean

remoteAddress

Returns string

remotePort

Returns number

securityTokenCount

Returns number

transactionsCount

Returns number

Methods

_rememberClientAddressAndPort

Returns void

abruptlyInterrupt

Returns void

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

close

Parameters

Optional callback: ErrorCallback

Returns void

dispose

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getCertificate

Returns Certificate

getCertificateChain