RingBufferT /

Public Member Functions

• RingBufferT ()

  Constructs a RingBufferT with size = 0.

• RingBufferT (size_t count)

  Constructs a RingBufferT with count maximum elements.

• RingBufferT (RingBufferT &&other)
• ~RingBufferT ()
• void
  resize (size_t count)

  Resizes the container to contain count maximum elements. Invalidates the internal buffer and resets read / write indices to 0.

  Must be synchronized with both read and write threads.

• void
  clear ()

  Invalidates the internal buffer and resets read / write indices to 0.

  Must be synchronized with both read and write threads.

• size_t
  getSize () const

  Returns the maximum number of elements.

• size_t
  getAvailableWrite () const

  Returns the number of elements available for wrtiing.

  Only safe to call from the write thread.

• size_t
  getAvailableRead () const

  Returns the number of elements available for wrtiing.

  Only safe to call from the read thread.

• bool
  write (const T *array, size_t count)

  Writes count elements into the internal buffer from array .

  true if all elements were successfully written, or false otherwise.

  only safe to call from the write thread. TODO: consider renaming this to writeAll / readAll, and having generic read / write that just does as much as it can

• bool
  read (T *array, size_t count)

  Reads count elements from the internal buffer into array .

  true if all elements were successfully read, or false otherwise.

  only safe to call from the read thread.