Class: Miasma::Models::Queuing

Inherits:
Types::API
  • Object
show all
Defined in:
lib/miasma/models/queuing.rb,
lib/miasma/models/queuing/queue.rb,
lib/miasma/models/queuing/queues.rb

Overview

Abstract queue API

Defined Under Namespace

Classes: Queue, Queues

Instance Method Summary collapse

Instance Method Details

#queue_all(options = {}) ⇒ Array<Models::Queuing::Queue>

Return all queues

Parameters:

  • options (Hash) (defaults to: {}) —

    filter

Returns:

Raises:

  • (NotImplementedError) 


48
49
50
 
# File 'lib/miasma/models/queuing.rb', line 48

def queue_all(options = {})
  raise NotImplementedError
end

#queue_deliver(queue, msg_or_msgs, options = {}) ⇒ Receipt

Deliver message(s) to queue

Parameters:

  • queue (Models::Queuing::Queue)
  • msg_or_msgs (String, Array<String>) —

    message(s) to deliver

  • options (Hash) (defaults to: {}) —

    delivery options

Returns:

  • (Receipt)

Raises:

  • (NotImplementedError) 


58
59
60
 
# File 'lib/miasma/models/queuing.rb', line 58

def queue_deliver(queue, msg_or_msgs, options = {})
  raise NotImplementedError
end

#queue_destroy(queue) ⇒ TrueClass, FalseClass

Delete the queue

Parameters:

Returns:

  • (TrueClass, FalseClass)

Raises:

  • (NotImplementedError) 


40
41
42
 
# File 'lib/miasma/models/queuing.rb', line 40

def queue_destroy(queue)
  raise NotImplementedError
end

#queue_receive(queue, options = {}) ⇒ Queue::Message+

Receive message(s) from queue

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/miasma/models/queuing.rb', line 67

def queue_receive(queue, options = {})
  raise NotImplementedError
end

#queue_reload(queue) ⇒ Models::Queuing::Queue

Reload the queue data from the API

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


32
33
34
 
# File 'lib/miasma/models/queuing.rb', line 32

def queue_reload(queue)
  raise NotImplementedError
end

#queue_save(queue) ⇒ Models::Queuing::Queue

Save the queue

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


24
25
26
 
# File 'lib/miasma/models/queuing.rb', line 24

def queue_save(queue)
  raise NotImplementedError
end

#queues(filter = {}) ⇒ Types::Collections<Models::Queuing::Queue>

Queues

Parameters:

  • filter (Hash) (defaults to: {}) —

    filtering options

Returns:



14
15
16
17
18
 
# File 'lib/miasma/models/queuing.rb', line 14

def queues(filter = {})
  memoize(:queues) do
    Queues.new(self)
  end
end