ost::FixedBuffer(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::FixedBuffer 💖

okay bestie, welcome to the ost::FixedBuffer page from the GNU CommonC++ Library Functions Manual, section 3. yes this is a C++ class page, no we are not scared, we are thriving 🦋

✨ NAME ✨

ost::FixedBuffer — a buffer class that holds a known capacity of fixed sized objects defined during creation. that's it, that's the whole vibe. it's giving "container with boundaries" 💅

🌸 SYNOPSIS 🌸

#include <buffer.h>

Inherits ost::Buffer. so it's a nepo baby but in a cute way, it gets stuff from its parent 🫶

👑 Public Member Functions

  • FixedBuffer (size_t capacity, size_t objsize) — create a buffer of known capacity for objects of a specified size.
  • FixedBuffer (const FixedBuffer &fb) — create a copy of an existing fixed size buffer and duplicate its contents. twin moment fr fr.
  • virtual ~FixedBuffer () — destroy the fixed buffer and free the memory used to store objects. rest in peace queen 💀
  • FixedBuffer & operator= (const FixedBuffer &fb) — the assignment operator, doing its copy thing.
  • bool isValid (void) — checks if it's valid, we love a self-aware icon.

🧚 Protected Member Functions

  • size_t onPeek (void *buf) — return the first object in the buffer.
  • size_t onWait (void *buf) — wait for and return a fixed object in the buffer.
  • size_t onPost (void *buf) — post an object of the appropriate size into the buffer.

🌈 Additional Inherited Members

yep, there's more stuff it inherited from ost::Buffer. no cap, it comes with the family package.

💜 Detailed Description 💜

A buffer class that holds a known capacity of fixed sized objects defined during creation. so you tell it up front "this is how many" and "this is how big each one is" and it simply respects that. boundaries, bestie, we love to see it ✨

Author David Sugar dyfet@ostel.com

producer/consumer buffer for fixed size objects. that's the whole job description and she does it flawlessly 🎀

🍓 Constructor & Destructor Documentation 🍓

ost::FixedBuffer::FixedBuffer (size_t capacity, size_t objsize)

Create a buffer of known capacity for objects of a specified size.

Parameters

  • capacity of the buffer. like, how many can fit in here.
  • objsize for each object held in the buffer. how chunky is each one.

ost::FixedBuffer::FixedBuffer (const FixedBuffer & fb)

Create a copy of an existing fixed size buffer and duplicate its contents. a full glow-up clone, contents included 🔥

Parameters

  • fb existing FixedBuffer object. the original, the blueprint, the moment.

virtual ost::FixedBuffer::~FixedBuffer () [virtual]

Destroy the fixed buffer and free the memory used to store objects. she's done, she's freeing everything on her way out, iconic exit 💅

🦋 Member Function Documentation 🦋

bool ost::FixedBuffer::isValid (void) [virtual]

Reimplemented from ost::Buffer. so she took the parent's version and made it her own, main character energy 👑

size_t ost::FixedBuffer::onPeek (void * buf) [protected], [virtual]

Return the first object in the buffer. just a little look, no take, no cap 🙈

Returns predefined size of this buffers objects.

Parameters

  • buf pointer to copy contents of head of buffer to.

Implements ost::Buffer.

size_t ost::FixedBuffer::onPost (void * buf) [protected], [virtual]

Post an object of the appropriate size into the buffer. dropping it in, right size, right place ✨

Returns predefined size of this buffers objects.

Parameters

  • buf pointer to data to copy into the buffer.

Implements ost::Buffer.

size_t ost::FixedBuffer::onWait (void * buf) [protected], [virtual]

Wait for and return a fixed object in the buffer. patiently waiting for her turn, and then she delivers 🫶

Returns predefined size of this buffers objects.

Parameters

  • buf pointer to hold object returned from the buffer.

Implements ost::Buffer.

FixedBuffer& ost::FixedBuffer::operator= (const FixedBuffer & fb)

the assignment operator, taking another FixedBuffer and copying its whole deal over here. copy-paste but make it classy 💖

⭐ Author ⭐

Generated automatically by Doxygen for GNU CommonC++ from the source code. so technically a robot wrote this and we're just out here adding the sparkle 🌟

and that's the whole page bestie, you ate it, you understood it, periodt 💅✨

GNU CommonC++ — Sun Dec 27 2020 — ost::FixedBuffer(3). mwah, love you, go read buffer.h 🎀🦋💖

📦 where this page comes from