Net::STOMP::Client::HeartBeat - Heart-beat support for Net::STOMP::Client
use Net::STOMP::Client; $stomp = Net::STOMP::Client->new(host => "127.0.0.1", port => 61613); ... # can set the desired configuration only _before_ connect() # the client can send heart-beats every 5 seconds $stomp->client_heart_beat(5); # the server should send heart-beats every 10 seconds $stomp->server_heart_beat(10); ... $stomp->connect(); ... # can get the negotiated configuration only _after_ connect() printf("negotiated heart-beats: client=%.3f server=%.3f\n", $stomp->client_heart_beat(), $stomp->server_heart_beat());
This module handles STOMP heart-beat negotiation. It is used internally by Net::STOMP::Client and should not be directly used elsewhere.
This module provides the following methods to Net::STOMP::Client:
get/set the client heart-beat
get/set the server heart-beat
get the time at which data was last received, i.e. read from the network socket
get the time at which data was last sent, i.e. written to the network socket
send a NOOP frame (using the noop() method) unless the last sent time is recent enough with regard to the client heart-beat settings
For consistency with other Perl modules (for instance Time::HiRes), time is always expressed as a fractional number of seconds.
Starting with STOMP 1.1, each end of a STOMP connection can check if the other end is alive via heart-beating.
In order to use heart-beating (which is disabled by default), the client must specify what it wants before sending the CONNECT frame. This can be done using the client_heart_beat and server_heart_beat options of the new() method or, this is equivalent, the client_heart_beat() and server_heart_beat() methods on the Net::STOMP::Client object.
CONNECT
client_heart_beat
server_heart_beat
After having received the CONNECTED frame, the client_heart_beat() and server_heart_beat() methods can be used to get the negotiated values.
CONNECTED
To prove that it is alive, the client just needs to call the beat() method when convenient.
To check if the server is alive, the client just needs to compare the current time and what is returned by the last_received() and server_heart_beat() methods. For instance:
$delta = $stomp->server_heart_beat(); if ($delta) { $inactivity = Time::HiRes::time() - $stomp->last_received(); printf("server looks dead!\n") if $inactivity > $delta; }
Net::STOMP::Client, Time::HiRes.
Lionel Cons http://cern.ch/lionel.cons
Copyright (C) CERN 2010-2017
To install Net::STOMP::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::STOMP::Client
CPAN shell
perl -MCPAN -e shell install Net::STOMP::Client
For more information on module installation, please visit the detailed CPAN module installation guide.