1 /*
2      File: CACFMessagePort.cpp
3  Abstract: CACFMessagePort.h
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 //=============================================================================
48 //	Includes
49 //=============================================================================
50 
51 #include "CACFMessagePort.h"
52 #include "CADebugMacros.h"
53 #include "CAException.h"
54 
55 //=============================================================================
56 //	CACFLocalMessagePort
57 //=============================================================================
58 
CACFLocalMessagePort(CFStringRef inName,CFMessagePortCallBack inPortCallBack,CFMessagePortInvalidationCallBack inInvalidationCallBack,void * inUserData)59 CACFLocalMessagePort::CACFLocalMessagePort(CFStringRef inName, CFMessagePortCallBack inPortCallBack, CFMessagePortInvalidationCallBack inInvalidationCallBack, void* inUserData)
60 :
61 	mMessagePort(NULL),
62 	mRunLoopSource(NULL),
63 	mDispatchQueue(NULL)
64 {
65 	//	create the CFMessagePort
66 	CFMessagePortContext theContext = { 0, inUserData, NULL, NULL, NULL };
67 	mMessagePort = CFMessagePortCreateLocal(NULL, inName, inPortCallBack, &theContext, NULL);
68 	if(mMessagePort != NULL)
69 	{
70 		//	add the invalidation callback, if any
71 		if(inInvalidationCallBack != NULL)
72 		{
73 			CFMessagePortSetInvalidationCallBack(mMessagePort, inInvalidationCallBack);
74 		}
75 	}
76 }
77 
~CACFLocalMessagePort()78 CACFLocalMessagePort::~CACFLocalMessagePort()
79 {
80 	if(mRunLoopSource != NULL)
81 	{
82 		CFRelease(mRunLoopSource);
83 	}
84 	if(mMessagePort != NULL)
85 	{
86 		CFMessagePortInvalidate(mMessagePort);
87 		CFRelease(mMessagePort);
88 	}
89 }
90 
GetRunLoopSource() const91 CFRunLoopSourceRef	CACFLocalMessagePort::GetRunLoopSource() const
92 {
93 	Assert(mDispatchQueue == NULL, "CACFLocalMessagePort::SetDispatchQueue: should have both a run loop source and a dispatch queue");
94 	if(mRunLoopSource == NULL)
95 	{
96 		const_cast<CACFLocalMessagePort*>(this)->mRunLoopSource = CFMessagePortCreateRunLoopSource(NULL, mMessagePort, 0);
97 	}
98 	return mRunLoopSource;
99 }
100 
SetDispatchQueue(dispatch_queue_t inDispatchQueue)101 void	CACFLocalMessagePort::SetDispatchQueue(dispatch_queue_t inDispatchQueue)
102 {
103 	Assert(mRunLoopSource == NULL, "CACFLocalMessagePort::SetDispatchQueue: should have both a run loop source and a dispatch queue");
104 	mDispatchQueue = inDispatchQueue;
105 	CFMessagePortSetDispatchQueue(mMessagePort, mDispatchQueue);
106 }
107 
108 //=============================================================================
109 //	CACFRemoteMessagePort
110 //=============================================================================
111 
CACFRemoteMessagePort(CFStringRef inName,CFMessagePortInvalidationCallBack inInvalidationCallBack)112 CACFRemoteMessagePort::CACFRemoteMessagePort(CFStringRef inName, CFMessagePortInvalidationCallBack inInvalidationCallBack)
113 :
114 	mMessagePort(NULL),
115 	mRunLoopSource(NULL),
116 	mDispatchQueue(NULL)
117 {
118 	//	create the CFMessagePort
119 	mMessagePort = CFMessagePortCreateRemote(NULL, inName);
120 	if(mMessagePort != NULL)
121 	{
122 		//	failure to create a remote port does not need to throw an exception
123 		//	because it isn't really an error since the port in question may not
124 		//	exist and this fact requires a more complex response than an excpeption
125 		//	provides for.
126 
127 		//	add the invalidation callback, if any
128 		if(inInvalidationCallBack != NULL)
129 		{
130 			CFMessagePortSetInvalidationCallBack(mMessagePort, inInvalidationCallBack);
131 		}
132 	}
133 }
134 
~CACFRemoteMessagePort()135 CACFRemoteMessagePort::~CACFRemoteMessagePort()
136 {
137 	if(mRunLoopSource != NULL)
138 	{
139 		CFRelease(mRunLoopSource);
140 	}
141 	if(mMessagePort != NULL)
142 	{
143 		//CFMessagePortInvalidate(mMessagePort);
144 		CFRelease(mMessagePort);
145 	}
146 }
147 
GetRunLoopSource() const148 CFRunLoopSourceRef	CACFRemoteMessagePort::GetRunLoopSource() const
149 {
150 	Assert(mDispatchQueue == NULL, "CACFRemoteMessagePort::SetDispatchQueue: should have both a run loop source and a dispatch queue");
151 	if(mRunLoopSource == NULL)
152 	{
153 		const_cast<CACFRemoteMessagePort*>(this)->mRunLoopSource = CFMessagePortCreateRunLoopSource(NULL, mMessagePort, 0);
154 	}
155 	return mRunLoopSource;
156 }
157 
SetDispatchQueue(dispatch_queue_t inDispatchQueue)158 void	CACFRemoteMessagePort::SetDispatchQueue(dispatch_queue_t inDispatchQueue)
159 {
160 	Assert(mRunLoopSource == NULL, "CACFRemoteMessagePort::SetDispatchQueue: should have both a run loop source and a dispatch queue");
161 	mDispatchQueue = inDispatchQueue;
162 	CFMessagePortSetDispatchQueue(mMessagePort, mDispatchQueue);
163 }
164