mDNSPosix/mDNSPosix.h

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