CheckLink Method

Will check the connection to the server.

Syntax

smpp.checkLink([callback])

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 this 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 method will check the connection to the server. This method is used to ensure that the host on the other end of the connection is still active, or that it is still available. While a socket connection may still be available between the client and server, the SMS application on the server may have been taken offline without releasing the socket, or the CPU may be bogged down, etc. This method will send a PDU to the server and wait the length of Timeout for a response.

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