Class: Concurrent::RingBuffer

Inherits:

Object

• Object
• Concurrent::RingBuffer

Defined in:

lib/concurrent/collection/ring_buffer.rb

Overview

non-thread safe buffer

Instance Method Summary

• #capacity ⇒ Integer

  The capacity of the buffer.

• #count ⇒ Integer

  The number of elements currently in the buffer.

• #empty? ⇒ Boolean

  True if buffer is empty, false otherwise.

• #full? ⇒ Boolean

  True if buffer is full, false otherwise.

• #initialize(capacity) ⇒ RingBuffer constructor

  A new instance of RingBuffer.

• #offer(value) ⇒ Boolean

  True if value has been inserted, false otherwise.

• #peek ⇒ Object

  The first available value and without removing it from the buffer.

• #poll ⇒ Object

  The first available value and removes it from the buffer.

Constructor Details

#initialize(capacity) ⇒ RingBuffer

# File 'lib/concurrent/collection/ring_buffer.rb', line 6

def initialize(capacity)
  @buffer = Array.new(capacity)
  @first = @last = 0
  @count = 0
end

Instance Method Details

#capacity ⇒ Integer

# File 'lib/concurrent/collection/ring_buffer.rb', line 14

def capacity
  @buffer.size
end

#count ⇒ Integer

# File 'lib/concurrent/collection/ring_buffer.rb', line 19

def count
  @count
end

#empty? ⇒ Boolean

# File 'lib/concurrent/collection/ring_buffer.rb', line 24

def empty?
  @count == 0
end

#full? ⇒ Boolean

# File 'lib/concurrent/collection/ring_buffer.rb', line 29

def full?
  @count == capacity
end

#offer(value) ⇒ Boolean

# File 'lib/concurrent/collection/ring_buffer.rb', line 35

def offer(value)
  return false if full?

  @buffer[@last] = value
  @last = (@last + 1) % @buffer.size
  @count += 1
  true
end

#peek ⇒ Object

# File 'lib/concurrent/collection/ring_buffer.rb', line 54

def peek
  @buffer[@first]
end

#poll ⇒ Object

# File 'lib/concurrent/collection/ring_buffer.rb', line 45

def poll
  result = @buffer[@first]
  @buffer[@first] = nil
  @first = (@first + 1) % @buffer.size
  @count -= 1
  result
end