CFSocket.h

   1 /*
   2  * Copyright (c) 2011 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
  24 /*      CFSocket.h
  25         Copyright (c) 1999-2011, Apple Inc.  All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFSOCKET__)
  29 #define __COREFOUNDATION_CFSOCKET__ 1
  30
  31 #include <CoreFoundation/CFRunLoop.h>
  32 #include <CoreFoundation/CFData.h>
  33
  34 CF_EXTERN_C_BEGIN
  35
  36 typedef struct __CFSocket * CFSocketRef;
  37
  38 /* A CFSocket contains a native socket within a structure that can
  39 be used to read from the socket in the background and make the data
  40 thus read available using a runloop source.  The callback used for
  41 this may be of three types, as specified by the callBackTypes
  42 argument when creating the CFSocket.
  43
  44 If kCFSocketReadCallBack is used, then data will not be
  45 automatically read, but the callback will be called when data
  46 is available to be read, or a new child socket is waiting to be
  47 accepted.
  48
  49 If kCFSocketAcceptCallBack is used, then new child sockets will be
  50 accepted and passed to the callback, with the data argument being
  51 a pointer to a CFSocketNativeHandle.  This is usable only with
  52 connection rendezvous sockets.
  53
  54 If kCFSocketDataCallBack is used, then data will be read in chunks
  55 in the background and passed to the callback, with the data argument
  56 being a CFDataRef.
  57
  58 These three types are mutually exclusive, but any one of them may
  59 have kCFSocketConnectCallBack added to it, if the socket will be
  60 used to connect in the background.  Connect in the background occurs
  61 if CFSocketConnectToAddress is called with a negative timeout
  62 value, in which case the call returns immediately, and a
  63 kCFSocketConnectCallBack is generated when the connect finishes.
  64 In this case the data argument is either NULL, or a pointer to
  65 an SInt32 error code if the connect failed.  kCFSocketConnectCallBack
  66 will never be sent more than once for a given socket.
  67
  68 The callback types may also have kCFSocketWriteCallBack added to
  69 them, if large amounts of data are to be sent rapidly over the
  70 socket and notification is desired when there is space in the
  71 kernel buffers so that the socket is writable again.
  72
  73 With a connection-oriented socket, if the connection is broken from the
  74 other end, then one final kCFSocketReadCallBack or kCFSocketDataCallBack
  75 will occur.  In the case of kCFSocketReadCallBack, the underlying socket
  76 will have 0 bytes available to read.  In the case of kCFSocketDataCallBack,
  77 the data argument will be a CFDataRef of length 0.
  78
  79 There are socket flags that may be set to control whether callbacks of
  80 a given type are automatically reenabled after they are triggered, and
  81 whether the underlying native socket will be closed when the CFSocket
  82 is invalidated.  By default read, accept, and data callbacks are
  83 automatically reenabled; write callbacks are not, and connect callbacks
  84 may not be, since they are sent once only.  Be careful about automatically
  85 reenabling read and write callbacks, since this implies that the
  86 callbacks will be sent repeatedly if the socket remains readable or
  87 writable respectively.  Be sure to set these flags only for callbacks
  88 that your CFSocket actually possesses; the result of setting them for
  89 other callback types is undefined.
  90
  91 Individual callbacks may also be enabled and disabled manually, whether
  92 they are automatically reenabled or not.  If they are not automatically
  93 reenabled, then they will need to be manually reenabled when the callback
  94 is ready to be received again (and not sooner).  Even if they are
  95 automatically reenabled, there may be occasions when it will be useful
  96 to be able to manually disable them temporarily and then reenable them.
  97 Be sure to enable and disable only callbacks that your CFSocket actually
  98 possesses; the result of enabling and disabling other callback types is
  99 undefined.
 100
 101 By default the underlying native socket will be closed when the CFSocket
 102 is invalidated, but it will not be if kCFSocketCloseOnInvalidate is
 103 turned off.  This can be useful in order to destroy a CFSocket but
 104 continue to use the underlying native socket.  The CFSocket must
 105 still be invalidated when it will no longer be used.  Do not in
 106 either case close the underlying native socket without invalidating
 107 the CFSocket.
 108
 109 Addresses are stored as CFDatas containing a struct sockaddr
 110 appropriate for the protocol family; make sure that all fields are
 111 filled in properly when passing in an address.
 112
 113 */
 114
 115 /* Values for CFSocketError */
 116 enum {
 117     kCFSocketSuccess = 0,
 118     kCFSocketError = -1,
 119     kCFSocketTimeout = -2
 120 };
 121 typedef CFIndex CFSocketError;
 122
 123 typedef struct {
 124     SInt32      protocolFamily;
 125     SInt32      socketType;
 126     SInt32      protocol;
 127     CFDataRef   address;
 128 } CFSocketSignature;
 129
 130 /* Values for CFSocketCallBackType */
 131 enum {
 132     kCFSocketNoCallBack = 0,
 133     kCFSocketReadCallBack = 1,
 134     kCFSocketAcceptCallBack = 2,
 135     kCFSocketDataCallBack = 3,
 136     kCFSocketConnectCallBack = 4,
 137     kCFSocketWriteCallBack = 8
 138 };
 139 typedef CFOptionFlags CFSocketCallBackType;
 140
 141 /* Socket flags */
 142 enum {
 143     kCFSocketAutomaticallyReenableReadCallBack = 1,
 144     kCFSocketAutomaticallyReenableAcceptCallBack = 2,
 145     kCFSocketAutomaticallyReenableDataCallBack = 3,
 146     kCFSocketAutomaticallyReenableWriteCallBack = 8,
 147 #if MAC_OS_X_VERSION_10_5 <= MAC_OS_X_VERSION_MAX_ALLOWED
 148     kCFSocketLeaveErrors = 64,
 149 #endif
 150     kCFSocketCloseOnInvalidate = 128
 151 };
 152
 153 typedef void (*CFSocketCallBack)(CFSocketRef s, CFSocketCallBackType type, CFDataRef address, const void *data, void *info);
 154 /* If the callback wishes to keep hold of address or data after the point that it returns, then it must copy them. */
 155
 156 typedef struct {
 157     CFIndex     version;
 158     void *      info;
 159     const void *(*retain)(const void *info);
 160     void        (*release)(const void *info);
 161     CFStringRef (*copyDescription)(const void *info);
 162 } CFSocketContext;
 163
 164 #if TARGET_OS_WIN32
 165 typedef uintptr_t CFSocketNativeHandle;
 166 #else
 167 typedef int CFSocketNativeHandle;
 168 #endif
 169
 170 CF_EXPORT CFTypeID      CFSocketGetTypeID(void);
 171
 172 CF_EXPORT CFSocketRef   CFSocketCreate(CFAllocatorRef allocator, SInt32 protocolFamily, SInt32 socketType, SInt32 protocol, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
 173 CF_EXPORT CFSocketRef   CFSocketCreateWithNative(CFAllocatorRef allocator, CFSocketNativeHandle sock, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
 174 CF_EXPORT CFSocketRef   CFSocketCreateWithSocketSignature(CFAllocatorRef allocator, const CFSocketSignature *signature, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
 175 CF_EXPORT CFSocketRef   CFSocketCreateConnectedToSocketSignature(CFAllocatorRef allocator, const CFSocketSignature *signature, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context, CFTimeInterval timeout);
 176 /* CFSocketCreateWithSignature creates a socket of the requested type and binds its address (using CFSocketSetAddress) to the requested address.  If this fails, it returns NULL.  CFSocketCreateConnectedToSignature creates a socket suitable for connecting to the requested type and address, and connects it (using CFSocketConnectToAddress).  If this fails, it returns NULL. */
 177
 178 CF_EXPORT CFSocketError CFSocketSetAddress(CFSocketRef s, CFDataRef address);
 179 CF_EXPORT CFSocketError CFSocketConnectToAddress(CFSocketRef s, CFDataRef address, CFTimeInterval timeout);
 180 CF_EXPORT void          CFSocketInvalidate(CFSocketRef s);
 181
 182 CF_EXPORT Boolean       CFSocketIsValid(CFSocketRef s);
 183 CF_EXPORT CFDataRef     CFSocketCopyAddress(CFSocketRef s);
 184 CF_EXPORT CFDataRef     CFSocketCopyPeerAddress(CFSocketRef s);
 185 CF_EXPORT void          CFSocketGetContext(CFSocketRef s, CFSocketContext *context);
 186 CF_EXPORT CFSocketNativeHandle  CFSocketGetNative(CFSocketRef s);
 187
 188 CF_EXPORT CFRunLoopSourceRef    CFSocketCreateRunLoopSource(CFAllocatorRef allocator, CFSocketRef s, CFIndex order);
 189
 190 CF_EXPORT CFOptionFlags CFSocketGetSocketFlags(CFSocketRef s);
 191 CF_EXPORT void          CFSocketSetSocketFlags(CFSocketRef s, CFOptionFlags flags);
 192 CF_EXPORT void          CFSocketDisableCallBacks(CFSocketRef s, CFOptionFlags callBackTypes);
 193 CF_EXPORT void          CFSocketEnableCallBacks(CFSocketRef s, CFOptionFlags callBackTypes);
 194
 195
 196 /* For convenience, a function is provided to send data using the socket with a timeout.  The timeout will be used only if the specified value is positive.  The address should be left NULL if the socket is already connected. */
 197 CF_EXPORT CFSocketError CFSocketSendData(CFSocketRef s, CFDataRef address, CFDataRef data, CFTimeInterval timeout);
 198
 199 /* Generic name registry functionality (CFSocketRegisterValue,
 200 CFSocketCopyRegisteredValue) allows the registration of any property
 201 list type.  Functions specific to CFSockets (CFSocketRegisterSocketData,
 202 CFSocketCopyRegisteredSocketData) register a CFData containing the
 203 components of a socket signature (protocol family, socket type,
 204 protocol, and address).  In each function the nameServerSignature
 205 may be NULL, or any component of it may be 0, to use default values
 206 (TCP, INADDR_LOOPBACK, port as set).  Name registration servers might
 207 not allow registration with other than TCP and INADDR_LOOPBACK.
 208 The actual address of the server responding to a query may be obtained
 209 by using the nameServerAddress argument.  This address, the address
 210 returned by CFSocketCopyRegisteredSocketSignature, and the value
 211 returned by CFSocketCopyRegisteredValue must (if non-null) be released
 212 by the caller.  CFSocketUnregister removes any registration associated
 213 with the specified name.
 214 */
 215
 216 CF_EXPORT CFSocketError CFSocketRegisterValue(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFPropertyListRef value);
 217 CF_EXPORT CFSocketError CFSocketCopyRegisteredValue(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFPropertyListRef *value, CFDataRef *nameServerAddress);
 218
 219 CF_EXPORT CFSocketError CFSocketRegisterSocketSignature(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, const CFSocketSignature *signature);
 220 CF_EXPORT CFSocketError CFSocketCopyRegisteredSocketSignature(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFSocketSignature *signature, CFDataRef *nameServerAddress);
 221
 222 CF_EXPORT CFSocketError CFSocketUnregister(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name);
 223
 224 CF_EXPORT void          CFSocketSetDefaultNameRegistryPortNumber(UInt16 port);
 225 CF_EXPORT UInt16        CFSocketGetDefaultNameRegistryPortNumber(void);
 226
 227 /* Constants used in name registry server communications */
 228 CF_EXPORT const CFStringRef kCFSocketCommandKey;
 229 CF_EXPORT const CFStringRef kCFSocketNameKey;
 230 CF_EXPORT const CFStringRef kCFSocketValueKey;
 231 CF_EXPORT const CFStringRef kCFSocketResultKey;
 232 CF_EXPORT const CFStringRef kCFSocketErrorKey;
 233 CF_EXPORT const CFStringRef kCFSocketRegisterCommand;
 234 CF_EXPORT const CFStringRef kCFSocketRetrieveCommand;
 235
 236 CF_EXTERN_C_END
 237
 238 #endif /* ! __COREFOUNDATION_CFSOCKET__ */
 239