Module: StompServer

### Home Classes Methods

### In Files

- lib/stomp_server.rb
- lib/stomp_server/protocols/http.rb
- lib/stomp_server/protocols/stomp.rb
- lib/stomp_server/queue.rb
- lib/stomp_server/queue/activerecord_queue.rb
- lib/stomp_server/queue/dbm_queue.rb
- lib/stomp_server/queue/file_queue.rb
- lib/stomp_server/queue/memory_queue.rb
- lib/stomp_server/queue_manager.rb
- lib/stomp_server/stomp_auth.rb
- lib/stomp_server/stomp_frame.rb
- lib/stomp_server/stomp_id.rb
- lib/stomp_server/stomp_user.rb
- lib/stomp_server/test_server.rb
- lib/stomp_server/topic_manager.rb

### Namespace

- MODULE StompServer::Protocols
- MODULE StompServer::TestServer
- CLASS StompServer::ActiveRecordQueue
- CLASS StompServer::Configurator
- CLASS StompServer::DBMQueue
- CLASS StompServer::FileQueue
- CLASS StompServer::MemoryQueue
- CLASS StompServer::Queue
- CLASS StompServer::QueueManager
- CLASS StompServer::QueueMonitor
- CLASS StompServer::Run
- CLASS StompServer::StompAuth
- CLASS StompServer::StompFrame
- CLASS StompServer::StompFrameRecognizer
- CLASS StompServer::StompId
- CLASS StompServer::StompUser
- CLASS StompServer::TopicManager

### Files

- History.txt
- Manifest.txt
- README.txt
- README.txt

### Class/Module Index

Quicksearch

- StompServer
- StompServer::ActiveRecordQueue
- StompServer::Configurator
- StompServer::DBMQueue
- StompServer::FileQueue
- StompServer::MemoryQueue
- StompServer::Protocols
- StompServer::Protocols::Http
- StompServer::Protocols::Stomp
- StompServer::Queue
- StompServer::QueueManager
- StompServer::QueueMonitor
- StompServer::Run
- StompServer::StompAuth
- StompServer::StompFrame
- StompServer::StompFrameRecognizer
- StompServer::StompId
- StompServer::StompUser
- StompServer::TestServer
- StompServer::TopicManager
- Mongrel
- Mongrel::HttpRequest
- ArMessage

No matching classes.

# StompServer

QueueManager is used in conjunction with a storage class. The storage class MUST implement the following two methods:

- enqueue(queue name, frame)

enqueue pushes a frame to the top of the queue in FIFO order. It's return value is ignored. enqueue must also set the message-id and add it to the frame header before inserting the frame into the queue.

- dequeue(queue name)

dequeue removes a frame from the bottom of the queue and returns it.

- requeue(queue name,frame)

does the same as enqueue, except it puts the from at the bottom of the queue

The storage class MAY implement the stop() method which can be used to do any housekeeping that needs to be done before stompserver shuts down. stop() will be called when stompserver is shut down.

The storage class MAY implement the monitor() method. monitor() should return a hash of hashes containing the queue statistics. See the file queue for an example. Statistics are available to clients in /queue/monitor.

topic - non persistent, sent to all interested parties

### Constants

VERSION

[Validate]

Generated with the Darkfish Rdoc Generator 2.