Jump to: navigation, search


< Zaqar
Revision as of 17:10, 14 March 2013 by Kgriffs (talk | contribs) (QueueController)

Marconi Endpoints

Endpoints define the protocol between a given transport and the storage driver. In this way, multiple transports like HTTP and ZMQ can be supported; they are not exclusive and can be enabled directly from the config file.

Related endpoints are grouped into one of several controllers, who's interface is defined by an abstract base class. The storage driver provides a concrete implementation for each controller type.

For specific implementations read: HTTP, ZMQ

Common Endpoints, exposed by Storage Drivers

Storage drivers export 3 controllers which group endpoints by resource.

TODO(kgriffs): Define params and valid ranges for each.


  • List Queues
    • Return list of queue names in alphabetical order
  • Get queue
  • Create or Update Queue
 * Requires messages.ttl
  • Delete Queue
  • Get queue stats
  • Get Actions
    • Delete message
    • Claim messages
    • Update claim
    • Release claim
    • Claim expired
    • Message expired


  • Get Message(s)
  • Post Message(s)
  • Delete Message


  • Claim messages
  • Query claim
  • Update claim
  • Release Claim
  • Claim Stats


The following endpoints only apply to specific transports.


  • Node health (test_reachable)
  • Get home document