IHeartbeat Interface Reference

Heart-beat interface. More...

Inheritance diagram for IHeartbeat:

Public Member Functions
	SendHeartbeat ()
	Send a Stomp heart-beat byte on the connection.
	CheckHeartbeat ()
	Check if a Stomp heart-beat byte was received on the connection.
Boolean	ReceiveHeartbeat (Integer ATimeOut)
	Try to read a Stomp heart-beat byte on the connection.

Detailed Description

Heart-beat interface.

Warning

This interface is not supported by OpenMQ.

Member Function Documentation

CheckHeartbeat()

IHeartbeat::CheckHeartbeat

(

)

Check if a Stomp heart-beat byte was received on the connection.

Exceptions

EBTStompError	if the server does not send heart-beats.
EBTStompServerHeartbeatMissing	if the heart-beat was late.

ReceiveHeartbeat()

Boolean IHeartbeat::ReceiveHeartbeat

(

Integer

ATimeOut

)

Try to read a Stomp heart-beat byte on the connection.

Parameters

ATimeOut

timeout

Returns

True if a heartbeat signal was received

Exceptions

EMQException	if the time-out is less than 1.
EMQException	if the transport layer is not connected.
EBTStompError	if the protocol level does not support heart-beats.

SendHeartbeat()

IHeartbeat::SendHeartbeat

(

)

Send a Stomp heart-beat byte on the connection.

Exceptions

EBTStompError

if the server does not expect heart-beats.