mDNSWindows/RMxServer.h

   1 /*
   2  * Copyright (c) 2003-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24
  25     Change History (most recent first):
  26
  27 $Log: RMxServer.h,v $
  28 Revision 1.1  2004/01/30 02:35:13  bradley
  29 Rendezvous Message Exchange implementation for DNS-SD IPC on Windows.
  30
  31 */
  32
  33 //---------------------------------------------------------------------------------------------------------------------------
  34 /*!     @header         RMxServer.h
  35
  36         @abstract       Server-side implementation of the DNS-SD IPC API.
  37
  38         @discussion
  39
  40         This listens for and accepts connections from IPC clients, starts server sessions, and acts as a mediator between the
  41         "direct" (compiled-in mDNSCore) code and the IPC client.
  42 */
  43
  44 #ifndef __RMx_SERVER__
  45 #define __RMx_SERVER__
  46
  47 #ifdef  __cplusplus
  48         extern "C" {
  49 #endif
  50
  51 #if 0
  52 #pragma mark == RMx ==
  53 #endif
  54
  55 //---------------------------------------------------------------------------------------------------------------------------
  56 /*!     @typedef        RMxServerFlags
  57
  58         @abstract       Flags to control how the server is stopped.
  59
  60         @constant       kRMxServerFlagsNone                     No flags.
  61         @constant       kRMxServerFlagsAllowRemote      Allow remote connections.
  62 */
  63
  64 typedef uint32_t                RMxServerFlags;
  65
  66 #define kRMxServerFlagsNone                             0
  67 #define kRMxServerFlagsAllowRemote              ( 1 << 0 )
  68
  69 //---------------------------------------------------------------------------------------------------------------------------
  70 /*!     @typedef        RMxServerStopFlags
  71
  72         @abstract       Flags to control how the server is stopped.
  73
  74         @constant       kRMxServerStopFlagsNone         No flags.
  75         @constant       kRMxServerStopFlagNoWait        Do not wait for the server to stop (signal and return).
  76 */
  77
  78 typedef uint32_t                RMxServerStopFlags;
  79
  80 #define kRMxServerStopFlagsNone                 0
  81 #define kRMxServerStopFlagsNoWait               ( 1 << 0 )
  82
  83 //---------------------------------------------------------------------------------------------------------------------------
  84 /*!     @function       RMxServerInitialize
  85
  86         @abstract       Initializes the RMx server.
  87 */
  88
  89 OSStatus        RMxServerInitialize( RMxServerFlags inFlags );
  90
  91 //---------------------------------------------------------------------------------------------------------------------------
  92 /*!     @function       RMxServerFinalize
  93
  94         @abstract       Finalizes the RMx server.
  95 */
  96
  97 void            RMxServerFinalize( void );
  98
  99 //---------------------------------------------------------------------------------------------------------------------------
 100 /*!     @function       RMxServerRun
 101
 102         @abstract       Runs the RMx server. Does not return unless stopped or an error occurs.
 103 */
 104
 105 OSStatus        RMxServerRun( void );
 106
 107 //---------------------------------------------------------------------------------------------------------------------------
 108 /*!     @function       RMxServerStop
 109
 110         @abstract       Stops the RMx server.
 111 */
 112
 113 OSStatus        RMxServerStop( RMxServerStopFlags inFlags );
 114
 115 #ifdef  __cplusplus
 116         }
 117 #endif
 118
 119 #endif  // __RMx_SERVER__