Class ServerSecureChannelLayer

subscribe now with sterfive to access the online-user manual

uses: MessageBuilder
uses: MessageChunker

Hierarchy

EventEmitter
- ServerSecureChannelLayer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServerSecureChannelLayer(options: ServerSecureChannelLayerOptions): ServerSecureChannelLayer

Overrides EventEmitter.constructor
- Defined in node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:153
Parameters
- options: ServerSecureChannelLayerOptions
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: {}

Type declaration

[key: string]: IServerSessionBase

timeout

timeout: number

Static registry

registry: ObjectRegistry

Static throttleTime

throttleTime: number

Accessors

aborted

get aborted(): boolean

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

bytesRead

get bytesRead(): number

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

Returns number

bytesWritten

get bytesWritten(): number

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

Returns number

certificateManager

get certificateManager(): ICertificateManager

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

hasSession

get hasSession(): boolean

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

Returns boolean

hashKey

get hashKey(): number

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

property

hashKey

Returns number

isOpened

get isOpened(): boolean

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

Returns boolean

remoteAddress

get remoteAddress(): string

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

remotePort

get remotePort(): number

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

securityTokenCount

get securityTokenCount(): number

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

transactionsCount

get transactionsCount(): number

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

Methods

_rememberClientAddressAndPort

_rememberClientAddressAndPort(): void

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

abruptlyInterrupt

abruptlyInterrupt(): void

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

close

close(callback?: ErrorCallback): void

- Defined in node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:206
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/dist/source/server/server_secure_channel_layer.d.ts:154
Returns void

getCertificate

getCertificate(): Buffer

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

getCertificate

Returns Buffer

the X509 DER form certificate

getCertificateChain

getCertificateChain(): Buffer

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

getCertificateChain

Returns Buffer

the X509 DER form certificate

getEndpointDescription

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

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

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

getPrivateKey

getPrivateKey(): string

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

getPrivateKey

Returns string

the privateKey

getRemoteFamily

getRemoteFamily(): string

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

getRemoteIPAddress

getRemoteIPAddress(): string

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

getRemotePort

getRemotePort(): number

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

getSignatureLength

getSignatureLength(): PublicKeyLength

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

init

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

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

init

async

Parameters
- socket: Socket
- callback: ErrorCallback
Returns void

send_fatal_error_and_abort

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

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

send_response

async

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

setSecurity

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

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

Generated using TypeDoc