diff options
author | Nat Goodspeed <nat@lindenlab.com> | 2024-05-14 21:02:28 -0400 |
---|---|---|
committer | Nat Goodspeed <nat@lindenlab.com> | 2024-05-14 21:02:28 -0400 |
commit | 094dcc07f8c1d90ae723dbe60eddacb90a09eae8 (patch) | |
tree | e750942e5f22ed677b543bd49509c2a7cdc5ce56 /indra/llplugin/llpluginsharedmemory.h | |
parent | d4043d3b011c32eb503c43c551872f9c24d7344f (diff) | |
parent | 38c2a5bde985a6a8a96d912d432f8bdf7e5b60be (diff) |
Merge DRTVWR-591-maint-X to main on promotion of secondlife/viewer #705: Maintenance X
Diffstat (limited to 'indra/llplugin/llpluginsharedmemory.h')
-rw-r--r-- | indra/llplugin/llpluginsharedmemory.h | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/indra/llplugin/llpluginsharedmemory.h b/indra/llplugin/llpluginsharedmemory.h index c6cd49cabb..a0aa885a58 100644 --- a/indra/llplugin/llpluginsharedmemory.h +++ b/indra/llplugin/llpluginsharedmemory.h @@ -1,25 +1,25 @@ -/** +/** * @file llpluginsharedmemory.h * * @cond * $LicenseInfo:firstyear=2008&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2010, Linden Research, Inc. - * + * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; * version 2.1 of the License only. - * + * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. - * + * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - * + * * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA * $/LicenseInfo$ * @endcond @@ -36,15 +36,15 @@ class LLPluginSharedMemoryPlatformImpl; */ class LLPluginSharedMemory { - LOG_CLASS(LLPluginSharedMemory); + LOG_CLASS(LLPluginSharedMemory); public: - LLPluginSharedMemory(); - ~LLPluginSharedMemory(); - - // Parent will use create/destroy, child will use attach/detach. - // Message transactions will ensure child attaches after parent creates and detaches before parent destroys. - - /** + LLPluginSharedMemory(); + ~LLPluginSharedMemory(); + + // Parent will use create/destroy, child will use attach/detach. + // Message transactions will ensure child attaches after parent creates and detaches before parent destroys. + + /** * Creates a shared memory segment, with a name which is guaranteed to be unique on the host at the current time. Used by parent. * Message transactions will (? TODO:DOC - should? must?) ensure child attaches after parent creates and detaches before parent destroys. * @@ -52,16 +52,16 @@ public: * * @return False for failure, true for success. */ - bool create(size_t size); - /** + bool create(size_t size); + /** * Destroys a shared memory segment. Used by parent. * Message transactions will (? TODO:DOC - should? must?) ensure child attaches after parent creates and detaches before parent destroys. * * @return True. TODO:DOC - always returns true. Is this the intended behavior? */ - bool destroy(void); - - /** + bool destroy(void); + + /** * Creates and attaches a name to a shared memory segment. TODO:DOC what's the difference between attach() and create()? * * @param[in] name Name to attach to memory segment @@ -69,55 +69,55 @@ public: * * @return False on failure, true otherwise. */ - bool attach(const std::string &name, size_t size); - /** + bool attach(const std::string &name, size_t size); + /** * Detaches shared memory segment. * * @return False on failure, true otherwise. */ - bool detach(void); + bool detach(void); - /** + /** * Checks if shared memory is mapped to a non-null address. * * @return True if memory address is non-null, false otherwise. */ - bool isMapped(void) const { return (mMappedAddress != NULL); }; - /** + bool isMapped(void) const { return (mMappedAddress != NULL); }; + /** * Get pointer to shared memory. * * @return Pointer to shared memory. */ - void *getMappedAddress(void) const { return mMappedAddress; }; - /** + void *getMappedAddress(void) const { return mMappedAddress; }; + /** * Get size of shared memory. * * @return Size of shared memory in bytes. TODO:DOC are bytes the correct unit? */ - size_t getSize(void) const { return mSize; }; - /** + size_t getSize(void) const { return mSize; }; + /** * Get name of shared memory. * * @return Name of shared memory. */ - std::string getName() const { return mName; }; - + std::string getName() const { return mName; }; + private: - bool map(void); - bool unmap(void); - bool close(void); - bool unlink(void); - - std::string mName; - size_t mSize; - void *mMappedAddress; - bool mNeedsDestroy; - - LLPluginSharedMemoryPlatformImpl *mImpl; - - static int sSegmentNumber; - static std::string createName(); - + bool map(void); + bool unmap(void); + bool close(void); + bool unlink(void); + + std::string mName; + size_t mSize; + void *mMappedAddress; + bool mNeedsDestroy; + + LLPluginSharedMemoryPlatformImpl *mImpl; + + static int sSegmentNumber; + static std::string createName(); + }; |