1 /*
2      File: CACFMessagePort.h
3  Abstract: Part of CoreAudio Utility Classes
4   Version: 1.1
5 
6  Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
7  Inc. ("Apple") in consideration of your agreement to the following
8  terms, and your use, installation, modification or redistribution of
9  this Apple software constitutes acceptance of these terms.  If you do
10  not agree with these terms, please do not use, install, modify or
11  redistribute this Apple software.
12 
13  In consideration of your agreement to abide by the following terms, and
14  subject to these terms, Apple grants you a personal, non-exclusive
15  license, under Apple's copyrights in this original Apple software (the
16  "Apple Software"), to use, reproduce, modify and redistribute the Apple
17  Software, with or without modifications, in source and/or binary forms;
18  provided that if you redistribute the Apple Software in its entirety and
19  without modifications, you must retain this notice and the following
20  text and disclaimers in all such redistributions of the Apple Software.
21  Neither the name, trademarks, service marks or logos of Apple Inc. may
22  be used to endorse or promote products derived from the Apple Software
23  without specific prior written permission from Apple.  Except as
24  expressly stated in this notice, no other rights or licenses, express or
25  implied, are granted by Apple herein, including but not limited to any
26  patent rights that may be infringed by your derivative works or by other
27  works in which the Apple Software may be incorporated.
28 
29  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
30  MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
31  THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
32  FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
33  OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
34 
35  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
36  OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38  INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
39  MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
40  AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
41  STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
42  POSSIBILITY OF SUCH DAMAGE.
43 
44  Copyright (C) 2014 Apple Inc. All Rights Reserved.
45 
46 */
47 #if !defined(__CACFMessagePort_h__)
48 #define __CACFMessagePort_h__
49 
50 //=============================================================================
51 //	Includes
52 //=============================================================================
53 
54 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
55 	#include <CoreFoundation/CFMessagePort.h>
56 #else
57 	#include <CFMessagePort.h>
58 #endif
59 
60 //=============================================================================
61 //	CACFLocalMessagePort
62 //=============================================================================
63 
64 class CACFLocalMessagePort
65 {
66 
67 //	Construction/Destruction
68 public:
69 						CACFLocalMessagePort(CFStringRef inName, CFMessagePortCallBack inPortCallBack, CFMessagePortInvalidationCallBack inInvalidationCallBack, void* inUserData = NULL);
70 	virtual				~CACFLocalMessagePort();
71 
72 //	Attributes
73 public:
IsValid()74 	bool				IsValid() const { return mMessagePort != NULL; }
GetMessagePortRef()75 	CFMessagePortRef	GetMessagePortRef() const { return mMessagePort; }
76 	CFRunLoopSourceRef	GetRunLoopSource() const;
77 	void				SetDispatchQueue(dispatch_queue_t inDispatchQueue);
78 
79 //	Implementation
80 protected:
81 	CFMessagePortRef	mMessagePort;
82 	CFRunLoopSourceRef	mRunLoopSource;
83 	dispatch_queue_t	mDispatchQueue;
84 
85 };
86 
87 //=============================================================================
88 //	CACFRemoteMessagePort
89 //=============================================================================
90 
91 class CACFRemoteMessagePort
92 {
93 
94 //	Construction/Destruction
95 public:
96 						CACFRemoteMessagePort(CFStringRef inName, CFMessagePortInvalidationCallBack inInvalidationCallBack);
97 	virtual				~CACFRemoteMessagePort();
98 
99 //	Attributes
100 public:
IsValid()101 	bool				IsValid() const { return mMessagePort != NULL; }
GetMessagePortRef()102 	CFMessagePortRef	GetMessagePortRef() const { return mMessagePort; }
103 	CFRunLoopSourceRef	GetRunLoopSource() const;
104 	void				SetDispatchQueue(dispatch_queue_t inDispatchQueue);
105 
106 //	Operations
107 public:
SendRequest(SInt32 inMessageID,CFDataRef inData,CFTimeInterval inSendTimeout,CFTimeInterval inReceiveTimout)108 	SInt32				SendRequest(SInt32 inMessageID, CFDataRef inData, CFTimeInterval inSendTimeout, CFTimeInterval inReceiveTimout) const { return CFMessagePortSendRequest(mMessagePort, inMessageID, inData, inSendTimeout, inReceiveTimout, NULL, NULL); }
SendRequest(SInt32 inMessageID,CFDataRef inData,CFTimeInterval inSendTimeout,CFTimeInterval inReceiveTimout,CFStringRef inReplyMode,CFDataRef & outReturnData)109 	SInt32				SendRequest(SInt32 inMessageID, CFDataRef inData, CFTimeInterval inSendTimeout, CFTimeInterval inReceiveTimout, CFStringRef inReplyMode, CFDataRef& outReturnData) const { return CFMessagePortSendRequest(mMessagePort, inMessageID, inData, inSendTimeout, inReceiveTimout, inReplyMode, &outReturnData); }
110 
111 //	Implementation
112 protected:
113 	CFMessagePortRef	mMessagePort;
114 	CFRunLoopSourceRef	mRunLoopSource;
115 	dispatch_queue_t	mDispatchQueue;
116 
117 };
118 
119 #endif
120