sc::ProcFileGrp(3)

🦋 sc::ProcFileGrp(3) — MPQC 🦋

✨ NAME ✨

Okay so sc::ProcFileGrp is the concrete class that provides an implementation of FileGrp for a single processor. That's the whole name situation, bestie. 💖

🌸 SYNOPSIS 🌸

#include <fileproc.h>

Inherits sc::FileGrp.

🎀 Public Member Functions 🎀

• ProcFileGrp (const Ref< KeyVal > &) — the constructor, taking a const Ref< KeyVal > &. No extra description here. 💅
• ProcFileGrp * clone () — clones the given FileGrp. The new FileGrp may need to be initialized additionally. Slay, but remember the extra init. ✨
• void set_localsize (size_t) — set the size of locally held data.
• void * localdata () — listed with no extra description on this page.
• void * obtain_readwrite (distsize_t offset, int size) — only one thread can have an unreleased obtain_readwrite at a time. 👀
• void * obtain_readonly (distsize_t offset, int size) — this gives read access to the file location. No locking is done.
• void * obtain_writeonly (distsize_t offset, int size) — this gives write access to the data location. No locking is done.
• void release_readonly (void *data, distsize_t offset, int size) — this is called when read access is no longer needed.
• void release_writeonly (void *data, distsize_t offset, int size) — this is called when write access is no longer needed.
• void release_readwrite (void *data, distsize_t offset, int size) — this is called when read/write access is no longer needed.
• void sync () — synchronizes all the nodes.

🌟 Additional Inherited Members 🌟

The page has this heading, and then no extra items are listed under it. So there's nothing else to spill here. 🙈

🌈 DETAILED DESCRIPTION 🌈

The ProcFileGrp concrete class provides an implementation of FileGrp for a single processor. That's the detailed description, and it ate. 💅✨

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

🌸 void* sc::ProcFileGrp::obtain_readwrite (distsize_t offset, int size)

[virtual] — bestie, only one thread can have an unreleased obtain_readwrite at a time. The actual file region locked can be larger than that requested. If the file region is already locked, this will block. For this reason, data should be held as read/write for as short a time as possible. Implements sc::FileGrp. 😭

🎀 void sc::ProcFileGrp::release_readwrite (void * data, distsize_t offset, int size)

[virtual] — this is called when read/write access is no longer needed. The data will be unlocked. Implements sc::FileGrp. 🔓

✨ void sc::ProcFileGrp::set_localsize (size_t)

[virtual] — set the size of locally held data. When data is accessed using a global offset, counting starts at node 0 and proceeds up to node n() - 1. Implements sc::FileGrp. 🧚

🦋 void sc::ProcFileGrp::sync ()

[virtual] — synchronizes all the nodes. Consider using this when the way you access data changes. Implements sc::FileGrp. 💫

💜 AUTHOR 💜

The author line literally says:

Generated automatically by Doxygen for MPQC from the source code.

---

Bye bestie! This was sc::ProcFileGrp(3) from MPQC — version 2.3.1, dated Sun Oct 4 2020. Mwah, stay iconic. 💖✨🦋