Heartbeat Property

The heartbeat timeout value.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetHeartbeat();
int SetHeartbeat(int iHeartbeat);

Unicode (Windows)
INT GetHeartbeat();
INT SetHeartbeat(INT iHeartbeat);

@property (nonatomic,readwrite,assign,getter=heartbeat,setter=setHeartbeat:) int heartbeat;
- (int)heartbeat;
- (void)setHeartbeat:(int)newHeartbeat;

#define PID_AMQPCLASSIC_HEARTBEAT 22

IPWORKSMQ_EXTERNAL void* IPWORKSMQ_CALL IPWorksMQ_AMQPClassic_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_AMQPClassic_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

0

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