Class: Agent::Queue::Buffered

Inherits:

Agent::Queue

• Object
• Agent::Queue
• Agent::Queue::Buffered

Defined in:

lib/agent/queue/buffered.rb

Instance Attribute Summary

• #max ⇒ Object readonly

  Returns the value of attribute max.

• #size ⇒ Object readonly

  Returns the value of attribute size.

Attributes inherited from Agent::Queue

#operations, #type

Instance Method Summary

• #buffered? ⇒ Boolean
• #initialize(type, max = 1) ⇒ Buffered constructor

  A new instance of Buffered.

• #pop? ⇒ Boolean
• #push? ⇒ Boolean
• #unbuffered? ⇒ Boolean

Methods inherited from Agent::Queue

#close, #closed?, #open?, #pop, #push, #remove_operations

Constructor Details

#initialize(type, max = 1) ⇒ Buffered

Returns a new instance of Buffered.

Raises:

• (Errors::InvalidQueueSize)

# File 'lib/agent/queue/buffered.rb', line 8

def initialize(type, max=1)
  raise Errors::InvalidQueueSize, "queue size must be at least 1" unless max >= 1
  super(type)
  @max = max
end

Instance Attribute Details

#max ⇒ Object (readonly)

Returns the value of attribute max.

# File 'lib/agent/queue/buffered.rb', line 6

def max
  @max
end

#size ⇒ Object (readonly)

Returns the value of attribute size.

# File 'lib/agent/queue/buffered.rb', line 6

def size
  @size
end

Instance Method Details

#buffered? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/agent/queue/buffered.rb', line 14

def buffered?;   true; end

#pop? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/agent/queue/buffered.rb', line 18

def pop?;  @size > 0;    end

#push? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/agent/queue/buffered.rb', line 17

def push?; @max > @size; end

#unbuffered? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/agent/queue/buffered.rb', line 15

def unbuffered?; false;  end