Version
menu_open
Target Platform(s):
Wwise SDK 2019.1.11
AkLock.h
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 #ifndef _AKLOCK_H_
29 #define _AKLOCK_H_
30 
31 #include <AK/SoundEngine/Common/AkTypes.h>
32 #include <windows.h> //For CRITICAL_SECTION
33 
34 //-----------------------------------------------------------------------------
35 // CAkLock class
36 //-----------------------------------------------------------------------------
37 class CAkLock
38 {
39 public:
40  /// Constructor
41  CAkLock()
42  {
43 #ifdef AK_USE_UWP_API
44  ::InitializeCriticalSectionEx( &m_csLock, 0, 0 );
45 #else
46  ::InitializeCriticalSection( &m_csLock );
47 #endif
48  }
49 
50  /// Destructor
51  ~CAkLock()
52  {
53  ::DeleteCriticalSection( &m_csLock );
54  }
55 
56  /// Lock
57  inline AKRESULT Lock( void )
58  {
59  ::EnterCriticalSection( &m_csLock );
60  return AK_Success;
61  }
62 
63  /// Unlock
64  inline AKRESULT Unlock( void )
65  {
66  ::LeaveCriticalSection( &m_csLock );
67  return AK_Success;
68  }
69 
70 /* // Returns AK_Success if lock aquired, AK_Fail otherwise.
71  inline AKRESULT Trylock( void )
72  {
73  if ( ::TryEnterCriticalSection( &m_csLock ) )
74  return AK_Success;
75  return AK_Fail;
76  } */
77 
78 private:
79  CRITICAL_SECTION m_csLock; ///< Platform specific lock
80 };
81 
82 #endif // _AKLOCK_H_
CAkLock::~CAkLock
~CAkLock()
Destructor.
Definition: AkLock.h:51
CAkLock
Definition: AkLock.h:37
CAkLock::Unlock
AKRESULT Unlock(void)
Unlock.
Definition: AkLock.h:64
CAkLock::CAkLock
CAkLock()
Constructor.
Definition: AkLock.h:41
CAkLock::Lock
AKRESULT Lock(void)
Lock.
Definition: AkLock.h:57

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise