qpid::broker::MessageStoreModule Class Reference

A null implementation of the MessageStore interface. More...

#include <MessageStoreModule.h>

Inheritance diagram for qpid::broker::MessageStoreModule:

Inheritance graph
[legend]
Collaboration diagram for qpid::broker::MessageStoreModule:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 MessageStoreModule (MessageStore *store)
bool init (const Options *options)
 init the store, call before any other call.
std::auto_ptr< TransactionContext > begin ()
std::auto_ptr
< TPCTransactionContext > 
begin (const std::string &xid)
void prepare (TPCTransactionContext &txn)
void commit (TransactionContext &txn)
void abort (TransactionContext &txn)
void collectPreparedXids (std::set< std::string > &xids)
void create (PersistableQueue &queue, const framing::FieldTable &args)
 Record the existence of a durable queue.
void destroy (PersistableQueue &queue)
 Destroy a durable queue.
void create (const PersistableExchange &exchange, const framing::FieldTable &args)
 Record the existence of a durable exchange.
void destroy (const PersistableExchange &exchange)
 Destroy a durable exchange.
void bind (const PersistableExchange &exchange, const PersistableQueue &queue, const std::string &key, const framing::FieldTable &args)
 Record a binding.
void unbind (const PersistableExchange &exchange, const PersistableQueue &queue, const std::string &key, const framing::FieldTable &args)
 Forget a binding.
void create (const PersistableConfig &config)
 Record generic durable configuration.
void destroy (const PersistableConfig &config)
 Destroy generic durable configuration.
void recover (RecoveryManager &queues)
void stage (boost::intrusive_ptr< PersistableMessage > &msg)
 Stores a messages before it has been enqueued (enqueueing automatically stores the message so this is only required if storage is required prior to that point).
void destroy (PersistableMessage &msg)
 Destroys a previously staged message.
void appendContent (boost::intrusive_ptr< const PersistableMessage > &msg, const std::string &data)
 Appends content to a previously staged message.
void loadContent (const qpid::broker::PersistableQueue &queue, boost::intrusive_ptr< const PersistableMessage > &msg, std::string &data, uint64_t offset, uint32_t length)
 Loads (a section) of content data for the specified message (previously stored through a call to stage or enqueue) into data.
void enqueue (TransactionContext *ctxt, boost::intrusive_ptr< PersistableMessage > &msg, const PersistableQueue &queue)
 Enqueues a message, storing the message if it has not been previously stored and recording that the given message is on the given queue.
void dequeue (TransactionContext *ctxt, boost::intrusive_ptr< PersistableMessage > &msg, const PersistableQueue &queue)
 Dequeues a message, recording that the given message is no longer on the given queue and deleting the message if it is no longer on any other queue.
u_int32_t outstandingQueueAIO (const PersistableQueue &queue)
 Returns the number of outstanding AIO's for a given queue.
void flush (const qpid::broker::PersistableQueue &queue)
 Flushes all async messages to disk for the specified queue.


Detailed Description

A null implementation of the MessageStore interface.

Member Function Documentation

bool qpid::broker::MessageStoreModule::init ( const Options options  )  [virtual]

init the store, call before any other call.

If not called, store is free to pick any defaults

Parameters:
dir the directory to create logs/db's
async true, enable async, false, enable sync
force true, delete data on mode change, false, error on mode change

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::stage ( boost::intrusive_ptr< PersistableMessage > &  msg  )  [virtual]

Stores a messages before it has been enqueued (enqueueing automatically stores the message so this is only required if storage is required prior to that point).

If the message has not yet been stored it will store the headers as well as any content passed in. A persistence id will be set on the message which can be used to load the content or to append to it.

TODO If it is know which queue the message is to be staged/ release to in cases of flowing tmp messages to disk for memory conservation set the queue ptr. This allows the store to optimize the read/writes for that queue and avoid searching based on id. Set queue = 0 for large message staging when the queue is not known.

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::destroy ( PersistableMessage msg  )  [virtual]

Destroys a previously staged message.

This only needs to be called if the message is never enqueued. (Once enqueued, deletion will be automatic when the message is dequeued from all queues it was enqueued onto).

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::loadContent ( const qpid::broker::PersistableQueue queue,
boost::intrusive_ptr< const PersistableMessage > &  msg,
std::string &  data,
uint64_t  offset,
uint32_t  length 
) [virtual]

Loads (a section) of content data for the specified message (previously stored through a call to stage or enqueue) into data.

The offset refers to the content only (i.e. an offset of 0 implies that the start of the content should be loaded, not the headers or related meta-data).

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::enqueue ( TransactionContext *  ctxt,
boost::intrusive_ptr< PersistableMessage > &  msg,
const PersistableQueue queue 
) [virtual]

Enqueues a message, storing the message if it has not been previously stored and recording that the given message is on the given queue.

Note: that this is async so the return of the function does not mean the opperation is complete.

Parameters:
msg the message to enqueue
queue the name of the queue onto which it is to be enqueued
xid (a pointer to) an identifier of the distributed transaction in which the operation takes place or null for 'local' transactions

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::dequeue ( TransactionContext *  ctxt,
boost::intrusive_ptr< PersistableMessage > &  msg,
const PersistableQueue queue 
) [virtual]

Dequeues a message, recording that the given message is no longer on the given queue and deleting the message if it is no longer on any other queue.

Note: that this is async so the return of the function does not mean the opperation is complete.

Parameters:
msg the message to dequeue
queue the name of the queue from which it is to be dequeued
xid (a pointer to) an identifier of the distributed transaction in which the operation takes place or null for 'local' transactions

Implements qpid::broker::MessageStore.

u_int32_t qpid::broker::MessageStoreModule::outstandingQueueAIO ( const PersistableQueue queue  )  [virtual]

Returns the number of outstanding AIO's for a given queue.

If 0, than all the enqueue / dequeues have been stored to disk

Parameters:
queue the name of the queue to check for outstanding AIO

Implements qpid::broker::MessageStore.

void qpid::broker::MessageStoreModule::flush ( const qpid::broker::PersistableQueue queue  )  [virtual]

Flushes all async messages to disk for the specified queue.

Note: that this is async so the return of the function does not mean the opperation is complete.

Parameters:
queue the name of the queue from which it is to be dequeued

Implements qpid::broker::MessageStore.


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

Generated on Thu May 15 22:23:18 2008 for Qpid by  doxygen 1.5.5