ServerSecureChannelLayer | NodeOPCUA reference documentation

uses: MessageBuilder
uses: MessageChunker

Hierarchy

EventEmitter
- ServerSecureChannelLayer

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ServerSecureChannelLayer(options: SeverSecureChannelLayerOptions): ServerSecureChannelLayer

- Defined in packages/node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:146
Parameters
- options: SeverSecureChannelLayerOptions
Returns ServerSecureChannelLayer

Properties

_on_response

_on_response: (msgType: string, response: Response, message: Message) => void

Type declaration

- (msgType: string, response: Response, message: Message): void
- Parameters
  - msgType: string
  - response: Response
  - message: Message
  Returns void

channelId

channelId: number

clientCertificate

clientCertificate: Buffer

clientNonce

clientNonce: Buffer

Optional clientSecurityHeader

clientSecurityHeader: SecurityHeader

Readonly messageBuilder

messageBuilder: MessageBuilder

receiverCertificate

receiverCertificate: Buffer

securityHeader

securityHeader: AsymmetricAlgorithmSecurityHeader

securityMode

securityMode: MessageSecurityMode

the channel message security mode

securityPolicy

securityPolicy: SecurityPolicy

the channel message security policy

sessionTokens

sessionTokens: any

timeout

timeout: number

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

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

registry: ObjectRegistry

Static throttleTime

throttleTime: number

Accessors

aborted

get aborted(): boolean

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

bytesRead

get bytesRead(): number

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

Returns number

bytesWritten

get bytesWritten(): number

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

Returns number

certificateManager

get certificateManager(): ICertificateManager

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

hasSession

get hasSession(): boolean

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

Returns boolean

hashKey

get hashKey(): number

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

property

hashKey

Returns number

isOpened

get isOpened(): boolean

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

Returns boolean

remoteAddress

get remoteAddress(): string

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

remotePort

get remotePort(): number

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

securityTokenCount

get securityTokenCount(): number

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

transactionsCount

get transactionsCount(): number

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

Methods

_rememberClientAddressAndPort

_rememberClientAddressAndPort(): void

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

abruptlyInterrupt

abruptlyInterrupt(): void

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

addListener

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

- 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 ServerSecureChannelLayer

close

close(callback?: ErrorCallback): void

- Defined in packages/node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:197
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/dist/source/server/server_secure_channel_layer.d.ts:148
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/server/server_secure_channel_layer.d.ts:165
method

getCertificate

Returns Buffer

the X509 DER form certificate

getCertificateChain

getCertificateChain(): Buffer

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

getCertificateChain

Returns Buffer

the X509 DER form certificate

getEndpointDescription

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

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

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

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/server/server_secure_channel_layer.d.ts:171
method

getPrivateKey

Returns string

the privateKey

getSignatureLength

getSignatureLength(): PublicKeyLength

- Defined in packages/node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:166
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/dist/source/server/server_secure_channel_layer.d.ts:198
Parameters
- securityMode: MessageSecurityMode
- securityPolicy: SecurityPolicy
Returns boolean

init

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

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

init

async

Parameters
- socket: Socket
- callback: ErrorCallback
Returns void

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): ServerSecureChannelLayer

- 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 ServerSecureChannelLayer

on

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

- 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 ServerSecureChannelLayer

once

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

- 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 ServerSecureChannelLayer

prependListener

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

- 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 ServerSecureChannelLayer

prependOnceListener

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

- 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 ServerSecureChannelLayer

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): ServerSecureChannelLayer

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

removeListener

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

- 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 ServerSecureChannelLayer

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/dist/source/server/server_secure_channel_layer.d.ts:188
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/dist/source/server/server_secure_channel_layer.d.ts:187
method

send_response

async

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

setMaxListeners

setMaxListeners(n: number): ServerSecureChannelLayer

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

setSecurity

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

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

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

Returns ServerSecureChannelLayer

Properties

_on_response

Type declaration

Parameters

msgType: string

response: Response

message: Message

Returns void

channelId

clientCertificate

clientNonce

Optional clientSecurityHeader

Readonly messageBuilder

receiverCertificate

securityHeader

securityMode

securityPolicy

sessionTokens

timeout

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static 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: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ServerSecureChannelLayer

close

Parameters

Optional callback: ErrorCallback

Returns void

dispose

Returns void

emit