IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

UseSSL Property

Determines if SSL is negotiated with incoming connections.

Syntax

 websocketserver.getUseSSL([callback])
 websocketserver.setUseSSL( useSSL, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getUseSSL([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setUseSSL([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

When set to True the class will attempt to negotiate SSL with all connecting clients. To enable SSL support you must supply a valid certificate via the SSLCertStoreType, SSLCertStore, SSLCertStorePassword, and SSLCertSubject properties

The default value is False.

This property is not available at design time.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Node.js Edition - Version 20.0 [Build 8155]