Class ServerSecureChannelLayer

class: ServerSecureChannelLayer
extends: EventEmitter
uses: MessageBuilder
uses: MessageChunker

Hierarchy

EventEmitter
- ServerSecureChannelLayer

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ServerSecureChannelLayer(options: SeverSecureChannelLayerOptions): ServerSecureChannelLayer

- Defined in node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:280
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

endpoint

endpoint: EndpointDescription | null

messageBuilder

messageBuilder: MessageBuilder

receiverCertificate

receiverCertificate: Buffer | null

securityHeader

securityHeader: AsymmetricAlgorithmSecurityHeader | null

securityMode

securityMode: MessageSecurityMode

sessionTokens

sessionTokens: any

timeout

timeout: number

Static defaultMaxListeners

defaultMaxListeners: number

Static registry

registry: any

Accessors

aborted

get aborted(): boolean

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

bytesRead

get bytesRead(): number

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

Returns number

bytesWritten

get bytesWritten(): number

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

Returns number

certificateManager

get certificateManager(): ICertificateManager

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

hasSession

get hasSession(): boolean

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

Returns boolean

hashKey

get hashKey(): number

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

property

hashKey

type

{String}

Returns number

isOpened

get isOpened(): boolean

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

Returns boolean

remoteAddress

get remoteAddress(): string

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

remotePort

get remotePort(): number

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

securityTokenCount

get securityTokenCount(): number

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

transactionsCount

get transactionsCount(): number

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

Methods

_rememberClientAddressAndPort

_rememberClientAddressAndPort(): void

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

abruptlyInterrupt

abruptlyInterrupt(): void

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

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(callback?: ErrorCallback): void

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

method

close

async

Parameters
- Optional callback: ErrorCallback
Returns void

dispose

dispose(): void

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

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getCertificate

getCertificate(): Certificate

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

getCertificate

Returns Certificate

the X509 DER form certificate

getCertificateChain

getCertificateChain(): Certificate

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

getCertificateChain

Returns Certificate

the X509 DER form certificate

getEndpointDescription

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

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

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

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

getPrivateKey

getPrivateKey(): PrivateKeyPEM

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

getPrivateKey

Returns PrivateKeyPEM

the privateKey

getSignatureLength

getSignatureLength(): PublicKeyLength

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

has_endpoint_for_security_mode_and_policy

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

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

init

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

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

init

async

Parameters
- socket: Socket
- callback: ErrorCallback
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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 EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
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 EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
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 EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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 EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
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 EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send_error_and_abort

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

- Defined in node-opcua-secure-channel/source/server/server_secure_channel_layer.ts:606
send a ServiceFault response

method

send_error_and_abort

async

Parameters
- statusCode: StatusCode
  
  the status code
- description: string
- message: Message
- callback: ErrorCallback
Returns void

send_response

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

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

send_response

async

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

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

setSecurity

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

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

Generated using TypeDoc