CFMessagePort.h

/*
 * Copyright (c) 2008-2012 Brent Fulgham <bfulgham@gmail.org>. All rights reserved.
 *
 * This source code is a modified version of the CoreFoundation sources released by Apple Inc. under
 * the terms of the APSL version 2.0 (see below).
 *
 * For information about changes from the original Apple source release can be found by reviewing the
 * source control system for the project at https://sourceforge.net/svn/?group_id=246198.
 *
 * The original license information is as follows:
 * 
 * Copyright (c) 2012 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/* CFMessagePort.h
 Copyright (c) 1998-2011, Apple Inc. All rights reserved.
*/

#if !defined(__COREFOUNDATION_CFMESSAGEPORT__)
#define__COREFOUNDATION_CFMESSAGEPORT__ 1

#include<CoreFoundation/CFString.h>
#include<CoreFoundation/CFRunLoop.h>
#include<CoreFoundation/CFData.h>
#if (TARGET_OS_MAC&& !(TARGET_OS_EMBEDDED||TARGET_OS_IPHONE)) || (TARGET_OS_EMBEDDED||TARGET_OS_IPHONE)
#include<dispatch/dispatch.h>
#endif

CF_EXTERN_C_BEGIN

typedefstruct__CFMessagePort*CFMessagePortRef;

enum {
kCFMessagePortSuccess=0,
kCFMessagePortSendTimeout=-1,
kCFMessagePortReceiveTimeout=-2,
kCFMessagePortIsInvalid=-3,
kCFMessagePortTransportError=-4,
kCFMessagePortBecameInvalidError=-5
};

typedefstruct {
CFIndexversion;
void*info;
constvoid*(*retain)(constvoid*info);
void (*release)(constvoid*info);
CFStringRef (*copyDescription)(constvoid*info);
} CFMessagePortContext;

typedefCFDataRef (*CFMessagePortCallBack)(CFMessagePortReflocal, SInt32msgid, CFDataRefdata, void*info);
/* If callout wants to keep a hold of the data past the return of the callout, it must COPY the data. This includes the case where the data is given to some routine which _might_ keep a hold of it; System will release returned CFData. */
typedefvoid (*CFMessagePortInvalidationCallBack)(CFMessagePortRefms, void*info);

CF_EXPORTCFTypeIDCFMessagePortGetTypeID(void);

CF_EXPORTCFMessagePortRefCFMessagePortCreateLocal(CFAllocatorRefallocator, CFStringRefname, CFMessagePortCallBackcallout, CFMessagePortContext*context, Boolean*shouldFreeInfo);
CF_EXPORTCFMessagePortRefCFMessagePortCreateRemote(CFAllocatorRefallocator, CFStringRefname);

CF_EXPORTBooleanCFMessagePortIsRemote(CFMessagePortRefms);
CF_EXPORTCFStringRefCFMessagePortGetName(CFMessagePortRefms);
CF_EXPORTBooleanCFMessagePortSetName(CFMessagePortRefms, CFStringRefnewName);
CF_EXPORTvoidCFMessagePortGetContext(CFMessagePortRefms, CFMessagePortContext*context);
CF_EXPORTvoidCFMessagePortInvalidate(CFMessagePortRefms);
CF_EXPORTBooleanCFMessagePortIsValid(CFMessagePortRefms);
CF_EXPORTCFMessagePortInvalidationCallBackCFMessagePortGetInvalidationCallBack(CFMessagePortRefms);
CF_EXPORTvoidCFMessagePortSetInvalidationCallBack(CFMessagePortRefms, CFMessagePortInvalidationCallBackcallout);

/* NULL replyMode argument means no return value expected, dont wait for it */
CF_EXPORTSInt32CFMessagePortSendRequest(CFMessagePortRefremote, SInt32msgid, CFDataRefdata, CFTimeIntervalsendTimeout, CFTimeIntervalrcvTimeout, CFStringRefreplyMode, CFDataRef*returnData);

CF_EXPORTCFRunLoopSourceRefCFMessagePortCreateRunLoopSource(CFAllocatorRefallocator, CFMessagePortReflocal, CFIndexorder);

#ifDEPLOYMENT_TARGET_MACOSX||DEPLOYMENT_TARGET_EMBEDDED
CF_EXPORTvoidCFMessagePortSetDispatchQueue(CFMessagePortRefms, dispatch_queue_tqueue) CF_AVAILABLE(10_6, 4_0);
#endif

CF_EXTERN_C_END

#endif/* ! __COREFOUNDATION_CFMESSAGEPORT__ */