CFMessagePort.h

   1 /*
   2  * Copyright (c) 2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*      CFMessagePort.h
  24         Copyright (c) 1998-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFMESSAGEPORT__)
  28 #define __COREFOUNDATION_CFMESSAGEPORT__ 1
  29
  30 #include <CoreFoundation/CFString.h>
  31 #include <CoreFoundation/CFRunLoop.h>
  32 #include <CoreFoundation/CFData.h>
  33
  34 CF_EXTERN_C_BEGIN
  35
  36 typedef struct __CFMessagePort * CFMessagePortRef;
  37
  38 enum {
  39     kCFMessagePortSuccess = 0,
  40     kCFMessagePortSendTimeout = -1,
  41     kCFMessagePortReceiveTimeout = -2,
  42     kCFMessagePortIsInvalid = -3,
  43     kCFMessagePortTransportError = -4
  44 };
  45
  46 typedef struct {
  47     CFIndex     version;
  48     void *      info;
  49     const void *(*retain)(const void *info);
  50     void        (*release)(const void *info);
  51     CFStringRef (*copyDescription)(const void *info);
  52 } CFMessagePortContext;
  53
  54 typedef CFDataRef (*CFMessagePortCallBack)(CFMessagePortRef local, SInt32 msgid, CFDataRef data, void *info);
  55 /* 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. */
  56 typedef void (*CFMessagePortInvalidationCallBack)(CFMessagePortRef ms, void *info);
  57
  58 CF_EXPORT CFTypeID      CFMessagePortGetTypeID(void);
  59
  60 CF_EXPORT CFMessagePortRef      CFMessagePortCreateLocal(CFAllocatorRef allocator, CFStringRef name, CFMessagePortCallBack callout, CFMessagePortContext *context, Boolean *shouldFreeInfo);
  61 CF_EXPORT CFMessagePortRef      CFMessagePortCreateRemote(CFAllocatorRef allocator, CFStringRef name);
  62
  63 CF_EXPORT Boolean       CFMessagePortIsRemote(CFMessagePortRef ms);
  64 CF_EXPORT CFStringRef   CFMessagePortGetName(CFMessagePortRef ms);
  65 CF_EXPORT Boolean       CFMessagePortSetName(CFMessagePortRef ms, CFStringRef newName);
  66 CF_EXPORT void          CFMessagePortGetContext(CFMessagePortRef ms, CFMessagePortContext *context);
  67 CF_EXPORT void          CFMessagePortInvalidate(CFMessagePortRef ms);
  68 CF_EXPORT Boolean       CFMessagePortIsValid(CFMessagePortRef ms);
  69 CF_EXPORT CFMessagePortInvalidationCallBack CFMessagePortGetInvalidationCallBack(CFMessagePortRef ms);
  70 CF_EXPORT void CFMessagePortSetInvalidationCallBack(CFMessagePortRef ms, CFMessagePortInvalidationCallBack callout);
  71
  72 /* NULL replyMode argument means no return value expected, dont wait for it */
  73 CF_EXPORT SInt32        CFMessagePortSendRequest(CFMessagePortRef remote, SInt32 msgid, CFDataRef data, CFTimeInterval sendTimeout, CFTimeInterval rcvTimeout, CFStringRef replyMode, CFDataRef *returnData);
  74
  75 CF_EXPORT CFRunLoopSourceRef    CFMessagePortCreateRunLoopSource(CFAllocatorRef allocator, CFMessagePortRef local, CFIndex order);
  76
  77 CF_EXTERN_C_END
  78
  79 #endif /* ! __COREFOUNDATION_CFMESSAGEPORT__ */
  80