aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/RWLockable.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /APEX_1.4/include/RWLockable.h
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'APEX_1.4/include/RWLockable.h')
-rw-r--r--APEX_1.4/include/RWLockable.h68
1 files changed, 68 insertions, 0 deletions
diff --git a/APEX_1.4/include/RWLockable.h b/APEX_1.4/include/RWLockable.h
new file mode 100644
index 00000000..2990f749
--- /dev/null
+++ b/APEX_1.4/include/RWLockable.h
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2008-2015, NVIDIA CORPORATION. All rights reserved.
+ *
+ * NVIDIA CORPORATION and its licensors retain all intellectual property
+ * and proprietary rights in and to this software, related documentation
+ * and any modifications thereto. Any use, reproduction, disclosure or
+ * distribution of this software and related documentation without an express
+ * license agreement from NVIDIA CORPORATION is strictly prohibited.
+ */
+
+
+#ifndef RWLOCKABLE_H
+#define RWLOCKABLE_H
+
+/**
+\file
+\brief The include containing the interface for any rw-lockable object in the APEX SDK
+*/
+
+#include "foundation/PxSimpleTypes.h"
+
+#include "ApexUsingNamespace.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+/**
+ * \brief Base class for any rw-lockable object implemented by APEX SDK
+ */
+class RWLockable
+{
+public:
+ /**
+ \brief Acquire RW lock for read access.
+
+ The APEX 1.3.3 SDK (and higher) provides a multiple-reader single writer mutex lock to coordinate
+ access to the APEX SDK API from multiple concurrent threads. This method will in turn invoke the
+ lockRead call on the APEX Scene. The source code fileName and line number are provided for debugging
+ purposes.
+ */
+ virtual void acquireReadLock(const char *fileName, const uint32_t lineno) const = 0;
+
+ /**
+ \brief Acquire RW lock for write access.
+
+ The APEX 1.3.3 SDK (and higher) provides a multiple-reader single writer mutex lock to coordinate
+ access to the APEX SDK API from multiple concurrent threads. This method will in turn invoke the
+ lockRead call on the APEX Scene. The source code fileName and line number are provided for debugging
+ purposes.
+ */
+ virtual void acquireWriteLock(const char *fileName, const uint32_t lineno) const = 0;
+
+ /**
+ \brief Release the RW read lock
+ */
+ virtual void releaseReadLock(void) const = 0;
+
+ /**
+ \brief Release the RW write lock
+ */
+ virtual void releaseWriteLock(void) const = 0;
+};
+
+}
+}
+#endif // RWLOCKABLE_H