Version
menu_open
link
Wwise SDK 2022.1.7
AkSyncCaller.h
Go to the documentation of this file.
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  Copyright (c) 2023 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkSyncLoader.h
28 
29 /// \file
30 /// Class for synchronous calls of asynchronous models
31 
32 #ifndef _AK_SYNC_CALLER_H_
33 #define _AK_SYNC_CALLER_H_
34 
36 
37 namespace AK
38 {
39  namespace SoundEngine
40  {
41  /// AkSyncLoader: Init to create a sync event, call the asynchronous method, passing
42  /// it the address of this object as the cookie, then call Wait.
43  class AkSyncCaller
44  {
45  public:
46 #if defined(AK_SUPPORT_THREADS)
47  /// Initialize.
48  AKRESULT Init()
49  {
50  if ( AKPLATFORM::AkCreateEvent( m_hEvent ) != AK_Success )
51  {
52  AKASSERT( !"Could not create synchronization event" );
53  return AK_Fail;
54  }
55  return AK_Success;
56  }
57 
58  /// Wait until the async function calls its callback.
59  AKRESULT Wait( AKRESULT in_eResult )
60  {
61  if ( in_eResult != AK_Success )
62  {
63  AKPLATFORM::AkDestroyEvent( m_hEvent );
64  return in_eResult;
65  }
66 
67  // Task queueing successful. Block until completion.
68  AKPLATFORM::AkWaitForEvent( m_hEvent );
69  AKPLATFORM::AkDestroyEvent( m_hEvent );
70 
71  return m_eResult;
72  }
73 
74  /// Call this from callback to release blocked thread.
75  inline void Done() { AKPLATFORM::AkSignalEvent( m_hEvent ); }
76 #else
77  AKRESULT Init() { m_bIsDone = false; return AK_Success;
78  }
79  inline bool IsDone() { return m_bIsDone; }
80  inline void Done() { m_bIsDone = true; }
81 #endif
82 
83  AKRESULT m_eResult; ///< Operation result
84 
85  private:
86 #if defined(AK_SUPPORT_THREADS)
87  AkEvent m_hEvent; ///< Sync event
88 #else
89  bool m_bIsDone;
90 #endif
91  };
92  }
93 }
94 
95 #endif // _AK_SYNC_CALLER_H_
Audiokinetic namespace.
@ AK_Fail
The operation failed.
Definition: AkTypes.h:202
semaphore_t AkEvent
Definition: AkTypes.h:73
void AkWaitForEvent(AkEvent &in_event)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:79
AKRESULT
Standard function call result.
Definition: AkTypes.h:199
@ AK_Success
The operation was successful.
Definition: AkTypes.h:201
void AkDestroyEvent(AkEvent &io_event)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:69
#define AKASSERT(Condition)
Definition: AkAssert.h:67
AKRESULT AkCreateEvent(AkEvent &out_event)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:57
AKRESULT m_eResult
Operation result.
Definition: AkSyncCaller.h:83
void AkSignalEvent(const AkEvent &in_event)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:86

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