AEMainThreadEndpoint.h
Go to the documentation of this file.
1 //
2 // AEMainThreadPoll.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 29/04/2016.
6 // Copyright © 2016 A Tasty Pixel. All rights reserved.
7 //
8 // This software is provided 'as-is', without any express or implied
9 // warranty. In no event will the authors be held liable for any damages
10 // arising from the use of this software.
11 //
12 // Permission is granted to anyone to use this software for any purpose,
13 // including commercial applications, and to alter it and redistribute it
14 // freely, subject to the following restrictions:
15 //
16 // 1. The origin of this software must not be misrepresented; you must not
17 // claim that you wrote the original software. If you use this software
18 // in a product, an acknowledgment in the product documentation would be
19 // appreciated but is not required.
20 //
21 // 2. Altered source versions must be plainly marked as such, and must not be
22 // misrepresented as being the original software.
23 //
24 // 3. This notice may not be removed or altered from any source distribution.
25 //
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #import <Foundation/Foundation.h>
32 #import "AETime.h"
33 
43 typedef void (^AEMainThreadEndpointHandler)(void * _Nullable data, size_t length);
44 
58 @interface AEMainThreadEndpoint : NSObject
59 
65 - (instancetype _Nullable)initWithHandler:(AEMainThreadEndpointHandler _Nonnull)handler;
66 
74 - (instancetype _Nullable)initWithHandler:(AEMainThreadEndpointHandler _Nonnull)handler bufferCapacity:(size_t)bufferCapacity;
75 
87 BOOL AEMainThreadEndpointSend(__unsafe_unretained AEMainThreadEndpoint * _Nonnull endpoint,
88  const void * _Nullable data, size_t length);
89 
101 void * _Nullable AEMainThreadEndpointCreateMessage(__unsafe_unretained AEMainThreadEndpoint * _Nonnull endpoint, size_t length);
102 
108 void AEMainThreadEndpointDispatchMessage(__unsafe_unretained AEMainThreadEndpoint * _Nonnull endpoint);
109 
110 @end
111 
112 #ifdef __cplusplus
113 }
114 #endif