SystemConfiguration.fproj/config.defs

   1 /*
   2  * Copyright (c) 2000, 2001, 2003-2005 Apple Computer, 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 /*
  25  * Modification History
  26  *
  27  * June 1, 2001                 Allan Nathanson <ajn@apple.com>
  28  * - public API conversion
  29  *
  30  * March 24, 2000               Allan Nathanson <ajn@apple.com>
  31  * - initial revision
  32  */
  33
  34 #include <mach/std_types.defs>
  35 #include <mach/mach_types.defs>
  36
  37 subsystem config 20000;
  38 serverprefix _;
  39
  40 import "config_types.h";
  41
  42 /*
  43  * serialized XML or UTF8 data (client->server)
  44  */
  45 type xmlData    = ^ array [] of MACH_MSG_TYPE_BYTE
  46         ctype : xmlData_t;
  47
  48 /*
  49  * serialized XML or UTF8 data (server->client)
  50  */
  51 type xmlDataOut = ^ array [] of MACH_MSG_TYPE_BYTE
  52         ctype : xmlDataOut_t;
  53
  54 /*
  55  * additional types
  56  */
  57 /*
  58 type task_move_send_t = MACH_MSG_TYPE_MOVE_SEND
  59         ctype: mach_port_t;
  60 */
  61
  62
  63 /*
  64  * Connection management API's
  65  */
  66
  67 routine configopen      (       server          : mach_port_t;
  68                                 name            : xmlData;
  69                                 options         : xmlData;
  70                          out    session         : mach_port_move_send_t;
  71                          out    status          : int;
  72             ServerAuditToken    audit_token     : audit_token_t);
  73
  74 routine configclose     (       server          : mach_port_t;
  75                          out    status          : int);
  76
  77 routine configlock      (       server          : mach_port_t;
  78                          out    status          : int);
  79
  80 routine configunlock    (       server          : mach_port_t;
  81                          out    status          : int);
  82
  83         skip;   /* reserved for future use */
  84         skip;   /* reserved for future use */
  85         skip;   /* reserved for future use */
  86         skip;   /* reserved for future use */
  87
  88 /*
  89  * Dynamic store access API's
  90  */
  91
  92 routine configlist      (       server          : mach_port_t;
  93                                 xmlData         : xmlData;
  94                                 isRegex         : int;
  95                          out    list            : xmlDataOut, dealloc;
  96                          out    status          : int);
  97
  98 routine configadd       (       server          : mach_port_t;
  99                                 key             : xmlData;
 100                                 data            : xmlData;
 101                          out    newInstance     : int;
 102                          out    status          : int);
 103
 104 routine configget       (       server          : mach_port_t;
 105                                 key             : xmlData;
 106                          out    data            : xmlDataOut, dealloc;
 107                          out    newInstance     : int;
 108                          out    status          : int);
 109
 110 routine configset       (       server          : mach_port_t;
 111                                 key             : xmlData;
 112                                 data            : xmlData;
 113                                 instance        : int;
 114                          out    newInstance     : int;
 115                          out    status          : int);
 116
 117 routine configremove    (       server          : mach_port_t;
 118                                 key             : xmlData;
 119                          out    status          : int);
 120
 121 routine configtouch     (       server          : mach_port_t;
 122                                 key             : xmlData;
 123                          out    status          : int);
 124
 125 routine configadd_s     (       server          : mach_port_t;
 126                                 key             : xmlData;
 127                                 data            : xmlData;
 128                          out    newInstance     : int;
 129                          out    status          : int);
 130
 131 routine confignotify    (       server          : mach_port_t;
 132                                 key             : xmlData;
 133                          out    status          : int);
 134
 135 routine configget_m     (       server          : mach_port_t;
 136                                 keys            : xmlData;
 137                                 patterns        : xmlData;
 138                          out    data            : xmlDataOut, dealloc;
 139                          out    status          : int);
 140
 141 routine configset_m     (       server          : mach_port_t;
 142                                 data            : xmlData;
 143                                 remove          : xmlData;
 144                                 notify          : xmlData;
 145                          out    status          : int);
 146
 147 /*
 148  * Notification API's
 149  */
 150
 151 routine notifyadd       (       server          : mach_port_t;
 152                                 key             : xmlData;
 153                                 isRegex         : int;
 154                          out    status          : int);
 155
 156 routine notifyremove    (       server          : mach_port_t;
 157                                 key             : xmlData;
 158                                 isRegex         : int;
 159                          out    status          : int);
 160
 161 routine notifychanges   (       server          : mach_port_t;
 162                          out    list            : xmlDataOut, dealloc;
 163                          out    status          : int);
 164
 165 routine notifyviaport   (       server          : mach_port_t;
 166                                 port            : mach_port_move_send_t;
 167                                 msgid           : mach_msg_id_t;
 168                          out    status          : int);
 169
 170 routine notifyviafd     (       server          : mach_port_t;
 171                                 path            : xmlData;
 172                                 identifier      : int;
 173                          out    status          : int);
 174
 175 routine notifyviasignal (       server          : mach_port_t;
 176                                 task            : task_t /*task_move_send_t*/;
 177                                 sig             : int;
 178                          out    status          : int);
 179
 180 routine notifycancel    (       server          : mach_port_t;
 181                          out    status          : int);
 182
 183 routine notifyset       (       server          : mach_port_t;
 184                                 keys            : xmlData;
 185                                 patterns        : xmlData;
 186                          out    status          : int);
 187
 188         skip;   /* reserved for future use */
 189         skip;   /* reserved for future use */
 190         skip;   /* reserved for future use */
 191
 192 /*
 193  * Miscellaneous API's
 194  */
 195
 196 routine snapshot        (       server          : mach_port_t;
 197                          out    status          : int);