#include <stomp_client.h>

Classes
struct	ack
class	impl
Public Member Functions
	stomp_client (size_t consumer_pool_size=1, const boost::posix_time::time_duration &keepalive_interval=boost::posix_time::seconds(30), const boost::posix_time::time_duration &reconnect_interval=boost::posix_time::seconds(1))
	~stomp_client ()
void	connect (const std::string &hostname, int port, boost::function< void(const boost::system::error_code &, const std::string &)> error_cb)
void	disconnect ()
void	subscribe (const std::string &topic, boost::function< void(const std::string &)> message_cb, ack::type ack_type=ack::automatic, const boost::posix_time::time_duration &max_msg_interval=boost::posix_time::pos_infin)
void	unsubscribe (const std::string &topic)
void	send (const std::string &topic, const std::string &message)
bool	is_connected () const
bool	is_online () const
uint64_t	get_num_processed () const
size_t	get_num_pending () const
Private Attributes
boost::shared_ptr< impl >	m_impl

Detailed Description

STOMP client implementation

This class implements a multi-stream, multi-thread STOMP client.

Definition at line 46 of file stomp_client.h.

Constructor & Destructor Documentation

moost::mq::stomp_client::stomp_client	(	size_t	consumer_pool_size = `1`,
		const boost::posix_time::time_duration &	keepalive_interval = `boost::posix_time::seconds(30)`,
		const boost::posix_time::time_duration &	reconnect_interval = `boost::posix_time::seconds(1)`
	)

Create a new client

Parameters:

consumer_pool_size	The number of threads from which messages shall be dispatched. This can be useful if the actual message processing is quite CPU intensive.
keepalive_interval	The interval in which keepalive packets will be sent to the server.
reconnect_interval	The interval in which reconnection attempts will be made after a failed connection attempt.

Definition at line 33 of file stomp_client.cpp.

moost::mq::stomp_client::~stomp_client ( )

Destroy a client

Definition at line 40 of file stomp_client.cpp.

Here is the call graph for this function:

Member Function Documentation

void moost::mq::stomp_client::connect	(	const std::string &	hostname,
		int	port,
		boost::function< void(const boost::system::error_code &, const std::string &)>	error_cb
	)

Connect to queue server

Parameters:

hostname	Host name of the queue server.
port	Port number of the queue server.
error_cb	Callback for asynchronous errors.

Definition at line 51 of file stomp_client.cpp.

Here is the caller graph for this function:

void moost::mq::stomp_client::disconnect ( )

Disconnect from queue server

Definition at line 56 of file stomp_client.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

size_t moost::mq::stomp_client::get_num_pending ( ) const

Get number of messages received but currently pending

Returns:: Number of pending messages.

Definition at line 95 of file stomp_client.cpp.

uint64_t moost::mq::stomp_client::get_num_processed ( ) const

Get number of messages processed by this object

Returns:: Number of processed messages.

Definition at line 90 of file stomp_client.cpp.

bool moost::mq::stomp_client::is_connected ( ) const

Check if the client object is connected to the server

Note that "being connected" is a state of the object. The object may be connected even though the server is offline, in which case the object will attempt to periodically reconnect to the server.

Returns:: Boolean indicating whether the client object is connected.

Definition at line 80 of file stomp_client.cpp.

Here is the caller graph for this function:

bool moost::mq::stomp_client::is_online ( ) const

Check if the connected server is online

Use this method to actually check if the connection between the client and server is healthy.

Returns:: Boolean indicating whether the server is online.

Definition at line 85 of file stomp_client.cpp.

Here is the caller graph for this function:

void moost::mq::stomp_client::send	(	const std::string &	topic,
		const std::string &	message
	)

Send message to the queue server

Parameters:

topic	Topic (destination) of the message.
message	Message content.

Definition at line 75 of file stomp_client.cpp.

void moost::mq::stomp_client::subscribe	(	const std::string &	topic,
		boost::function< void(const std::string &)>	message_cb,
		ack::type	ack_type = `ack::automatic`,
		const boost::posix_time::time_duration &	max_msg_interval = `boost::posix_time::pos_infin`
	)

Subscribe to a topic

Parameters:

topic	Topic (destination) to subscribe to.
message_cb	Callback for received messages for this topic.
ack_type	Which acknowledgement protocol to use.
max_msg_interval	The maximum expected interval between any two messages. If this interval is exceeded, the client will initiate a reconnect to the server.

Definition at line 64 of file stomp_client.cpp.

Here is the caller graph for this function:

void moost::mq::stomp_client::unsubscribe ( const std::string & topic )

Unsubscribe from a topic

Parameters:

topic Topic (destination) to unsubscribe from.

Definition at line 70 of file stomp_client.cpp.

Member Data Documentation

boost::shared_ptr<impl> moost::mq::stomp_client::m_impl [private]

Definition at line 169 of file stomp_client.h.

The documentation for this class was generated from the following files:

/home/mhx/git/github/libmoost/include/moost/mq/stomp_client.h
/home/mhx/git/github/libmoost/src/mq/stomp_client.cpp

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation