UseTCP Property
Whether to use TCP.
Syntax
syslog.getUseTCP([callback]) syslog.setUseTCP( useTCP, [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 getUseTCP([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 setUseTCP([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
This property specifies whether TCP is used. By default this proprety is False and UDP is used. When set to True TCP will be used as the underlying protocol.
When set to True the following additional settings are also applicable:
- SSLAuthenticateClients
- SSLEnabled
- SSLAcceptServerCert*
- SSLCert*
- SSLServerCert*
- TCPMessageDelimiter
Data Type
Boolean