Heartbeat Property
The heartbeat timeout value.
Syntax
amqpclassic.getHeartbeat([callback]) amqpclassic.setHeartbeat( heartbeat, [callback])
Default Value
0
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 getHeartbeat([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 setHeartbeat([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 the heartbeat timeout value, in seconds. Heartbeats are disabled if set to 0 (default).
Before connecting, this property can be set to indicate the desired heartbeat timeout value. During the connection process, the class and the server will compare their desired heartbeat values and choose the lower one.
Once connected, this property will reflect the agreed-upon heartbeat value. While the connection is idle, heartbeats are sent by both the class and the server approximately once every (Heartbeat / 2) seconds. If either side has not received a heartbeat (or other transmission) for ~Heartbeat seconds, it will consider the other side unreachable and close the connection.
This setting cannot be changed while connected.
This property is not available at design time.
Data Type
Integer