mDNSPosix/mDNSPosix.h

   1 /* -*- Mode: C; tab-width: 4 -*-
   2  *
   3  * Copyright (c) 2002-2004 Apple Computer, Inc. All rights reserved.
   4  *
   5  * @APPLE_LICENSE_HEADER_START@
   6  *
   7  * This file contains Original Code and/or Modifications of Original Code
   8  * as defined in and that are subject to the Apple Public Source License
   9  * Version 2.0 (the 'License'). You may not use this file except in
  10  * compliance with the License. Please obtain a copy of the License at
  11  * http://www.opensource.apple.com/apsl/ and read it before using this
  12  * file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  19  * Please see the License for the specific language governing rights and
  20  * limitations under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23
  24     Change History (most recent first):
  25
  26 $Log: mDNSPosix.h,v $
  27 Revision 1.16  2004/11/30 22:37:01  cheshire
  28 Update copyright dates and add "Mode: C; tab-width: 4" headers
  29
  30 Revision 1.15  2004/02/06 01:19:51  cheshire
  31 Conditionally exclude IPv6 code unless HAVE_IPV6 is set
  32
  33 Revision 1.14  2004/01/28 21:12:15  cheshire
  34 Reconcile mDNSIPv6Support & HAVE_IPV6 into a single flag (HAVE_IPV6)
  35
  36 Revision 1.13  2004/01/24 05:12:03  cheshire
  37 <rdar://problem/3534352>: Need separate socket for issuing unicast queries
  38
  39 Revision 1.12  2004/01/23 21:37:08  cheshire
  40 For consistency, rename multicastSocket to multicastSocket4, and multicastSocketv6 to multicastSocket6
  41
  42 Revision 1.11  2003/12/11 03:03:51  rpantos
  43 Clean up mDNSPosix so that it builds on OS X again.
  44
  45 Revision 1.10  2003/12/08 20:47:02  rpantos
  46 Add support for mDNSResponder on Linux.
  47
  48 Revision 1.9  2003/10/30 19:25:19  cheshire
  49 Fix warning on certain compilers
  50
  51 Revision 1.8  2003/08/12 19:56:26  cheshire
  52 Update to APSL 2.0
  53
  54 Revision 1.7  2003/07/02 21:19:59  cheshire
  55 <rdar://problem/3313413> Update copyright notices, etc., in source code comments
  56
  57 Revision 1.6  2003/03/13 03:46:21  cheshire
  58 Fixes to make the code build on Linux
  59
  60 Revision 1.5  2003/03/08 00:35:56  cheshire
  61 Switched to using new "mDNS_Execute" model (see "mDNSCore/Implementer Notes.txt")
  62
  63 Revision 1.4  2002/12/23 22:13:31  jgraessl
  64
  65 Reviewed by: Stuart Cheshire
  66 Initial IPv6 support for mDNSResponder.
  67
  68 Revision 1.3  2002/09/21 20:44:53  zarzycki
  69 Added APSL info
  70
  71 Revision 1.2  2002/09/19 04:20:44  cheshire
  72 Remove high-ascii characters that confuse some systems
  73
  74 Revision 1.1  2002/09/17 06:24:34  cheshire
  75 First checkin
  76
  77 */
  78
  79 #ifndef __mDNSPlatformPosix_h
  80 #define __mDNSPlatformPosix_h
  81
  82 #include <signal.h>
  83 #include <sys/time.h>
  84
  85 #ifdef  __cplusplus
  86     extern "C" {
  87 #endif
  88
  89 // PosixNetworkInterface is a record extension of the core NetworkInterfaceInfo
  90 // type that supports extra fields needed by the Posix platform.
  91 //
  92 // IMPORTANT: coreIntf must be the first field in the structure because
  93 // we cast between pointers to the two different types regularly.
  94
  95 typedef struct PosixNetworkInterface PosixNetworkInterface;
  96
  97 struct PosixNetworkInterface
  98         {
  99         NetworkInterfaceInfo    coreIntf;
 100         const char *            intfName;
 101         PosixNetworkInterface * aliasIntf;
 102         int                     index;
 103         int                     multicastSocket4;
 104 #if HAVE_IPV6
 105         int                     multicastSocket6;
 106 #endif
 107         };
 108
 109 // This is a global because debugf_() needs to be able to check its value
 110 extern int gMDNSPlatformPosixVerboseLevel;
 111
 112 struct mDNS_PlatformSupport_struct
 113         {
 114         int unicastSocket4;
 115 #if HAVE_IPV6
 116         int unicastSocket6;
 117 #endif
 118         };
 119
 120 extern mStatus mDNSPlatformPosixRefreshInterfaceList(mDNS *const m);
 121     // See comment in implementation.
 122
 123 // Call mDNSPosixGetFDSet before calling select(), to update the parameters
 124 // as may be necessary to meet the needs of the mDNSCore code.
 125 // The timeout pointer MUST NOT be NULL.
 126 // Set timeout->tv_sec to 0x3FFFFFFF if you want to have effectively no timeout
 127 // After calling mDNSPosixGetFDSet(), call select(nfds, &readfds, NULL, NULL, &timeout); as usual
 128 // After select() returns, call mDNSPosixProcessFDSet() to let mDNSCore do its work
 129 extern void mDNSPosixGetFDSet(mDNS *m, int *nfds, fd_set *readfds, struct timeval *timeout);
 130 extern void mDNSPosixProcessFDSet(mDNS *const m, fd_set *readfds);
 131
 132 typedef void (*mDNSPosixEventCallback)( void *context);
 133
 134 extern mStatus mDNSPosixAddFDToEventLoop( int fd, mDNSPosixEventCallback callback, void *context);
 135 extern mStatus mDNSPosixRemoveFDFromEventLoop( int fd);
 136 extern mStatus mDNSPosixListenForSignalInEventLoop( int signum);
 137 extern mStatus mDNSPosixIgnoreSignalInEventLoop( int signum);
 138 extern mStatus mDNSPosixRunEventLoopOnce( mDNS *m, const struct timeval *pTimeout, sigset_t *pSignalsReceived, mDNSBool *pDataDispatched);
 139
 140 #ifdef  __cplusplus
 141     }
 142 #endif
 143
 144 #endif