ost::MapTable(3)

📦 version 1.8.1, in ubuntu jammy

🌸 ost::MapTable(3) 🌸

okay bestie, gather round, because we're about to talk about ost::MapTable — and yes, this is a page from the Library Functions Manual, section 3, so it's a library function, not a command. iykyk 💅

✨ NAME ✨

ost::MapTable — a map table allows for entities to be mapped (hash index) onto it. that's it. that's the whole vibe. 🎀

🦋 SYNOPSIS 🦋

#include <object.h>

Inherits ost::Mutex. yes ma'am, thread-safe by inheritance, we love to see it 👑

💖 Public Member Functions 💖

  • MapTable(unsigned size) — create a map table with a specified number of slots ✨
  • virtual ~MapTable() — destroy the table, calls cleanup 💀
  • virtual unsigned getIndex(const char *id) — get index value from id string
  • unsigned getRange(void) — return range of this table
  • unsigned getSize(void) — return the number of object stored in this table
  • void *getObject(const char *id) — lookup an object by id key
  • void addObject(MapObject &obj) — map an object to our table
  • void *getFirst() — get the first element into table, it is returned as void * for easy re-cast
  • void *getLast() — get the last element into table, it is returned as void * for easy re-cast
  • void *getEnd() — get table's end, useful for cycle control; it is returned as void * for easy re-cast
  • void *getFree(void) — get next object from managed free list
  • void addFree(MapObject *obj) — add an object to the managed free list
  • MapTable &operator+=(MapObject &obj) — an operator to map an object to the table
  • virtual MapTable &operator-=(MapObject &obj) — this operator is virtual in case it must also add the object to a managed free list

🎀 Protected Member Functions 🎀

  • void cleanup(void)

🌈 Protected Attributes 🌈

  • unsigned range
  • unsigned count
  • MapObject ** map

🫶 Friends 🫶

  • class MapObject
  • class MapIndex

⭐ Additional Inherited Members ⭐

👑 DETAILED DESCRIPTION 👑

A map table allows for entities to be mapped (hash index) onto it. lowkey iconic, ngl.

Unlike with Assoc, this form of map table also allows objects to be removed from the table. it also includes a mutex lock for thread safety (main character energy fr fr). a free list is also optionally maintained for reusable maps 💅

💜 Author 💜

David Sugar dyfet@gnutelephony.org

Table to hold hash indexed objects. periodt. 🍓

🧚 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🧚

🌸 ost::MapTable::MapTable(unsigned size) 🌸

Create a map table with a specified number of slots ✨

Parameters

  • number of slots.

💀 virtual ost::MapTable::~MapTable() [virtual] 💀

Destroy the table, calls cleanup. rip to the table, it did its best 😭

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

🎀 void ost::MapTable::addFree(MapObject * obj) 🎀

Add an object to the managed free list. Some MapObject's may override delete operator to detach and do this. sneaky but valid 💅

Parameters

  • object to add.

🦋 void ost::MapTable::addObject(MapObject & obj) 🦋

Map an object to our table. If it is in another table already, it is removed there first. no double-dipping bestie 🚫

Parameters

  • object to map.

✨ void ost::MapTable::cleanup(void) [protected] ✨

(no description, she's mysterious, she's private-ish, we respect that 🙈)

👑 void* ost::MapTable::getEnd() [inline] 👑

Get table's end, useful for cycle control; it is returned as void * for easy re-cast.

Returns

  • pointer to found object or NULL.

🌈 void* ost::MapTable::getFirst() 🌈

Get the first element into table, it is returned as void * for easy re-cast.

Returns

  • pointer to found object or NULL.

💖 void* ost::MapTable::getFree(void) 💖

Get next object from managed free list. This returns as a void so it can be recast into the actual type being used in derived MapObject's. A derived version of MapTable may well offer an explicit type version of this. Some derived MapObject's may override new to use managed list.

Returns

  • next object on free list.

⭐ virtual unsigned ost::MapTable::getIndex(const char * id) [virtual] ⭐

Get index value from id string. This function can be changed as needed to provide better collision avoidence for specific tables. (yes, "avoidence" — we are quoting the source, we do not fix the source, that's the rule 💅)

Parameters

  • id string

Returns

  • index slot in table.

🍓 void* ost::MapTable::getLast() 🍓

Get the last element into table, it is returned as void * for easy re-cast.

Returns

  • pointer to found object or NULL.

🌸 void* ost::MapTable::getObject(const char * id) 🌸

Lookup an object by id key. It is returned as void * for easy re-cast.

Parameters

  • key to find.

Returns

  • pointer to found object or NULL.

🎀 unsigned ost::MapTable::getRange(void) [inline] 🎀

Return range of this table.

Returns

  • table range.

💜 unsigned ost::MapTable::getSize(void) [inline] 💜

Return the number of object stored in this table.

Returns

  • table size.

🧚 MapTable& ost::MapTable::operator+=(MapObject & obj) 🧚

An operator to map an object to the table.

Returns

  • table being used.

Parameters

  • object being mapped.

💅 virtual MapTable& ost::MapTable::operator-=(MapObject & obj) [virtual] 💅

This operator is virtual in case it must also add the object to a managed free list.

Returns

  • current table.

Parameters

  • object entity to remove.
  • friend class MapIndex [friend]
  • friend class MapObject [friend]

💖 MEMBER DATA DOCUMENTATION 💖

  • unsigned ost::MapTable::count [protected]
  • MapObject** ost::MapTable::map [protected]
  • unsigned ost::MapTable::range [protected]

🌟 AUTHOR 🌟

Generated automatically by Doxygen for GNU CommonC++ from the source code.

and that's the whole page bestie!! 🎉 this lil doc drop came from GNU CommonC++ and was dated Sun Dec 27 2020 — shoutout to the manpage, she ate and left no crumbs 👑💖

📦 where this page comes from