SystemConfiguration.fproj/config.defs

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22
  23 /*
  24  * Modification History
  25  *
  26  * June 1, 2001                 Allan Nathanson <ajn@apple.com>
  27  * - public API conversion
  28  *
  29  * March 24, 2000               Allan Nathanson <ajn@apple.com>
  30  * - initial revision
  31  */
  32
  33 #include <mach/std_types.defs>
  34 #include <mach/mach_types.defs>
  35
  36 subsystem config 20000;
  37 serverprefix _;
  38
  39 import "config_types.h";
  40
  41 /*
  42  * serialized XML data (client->server)
  43  */
  44 type xmlData    = ^ array [] of MACH_MSG_TYPE_BYTE
  45         ctype : xmlData_t;
  46
  47 /*
  48  * serialized XML data (server->client)
  49  */
  50 type xmlDataOut = ^ array [] of MACH_MSG_TYPE_BYTE
  51         ctype : xmlDataOut_t;
  52
  53 /*
  54  * additional types
  55  */
  56 /*
  57 type task_move_send_t = MACH_MSG_TYPE_MOVE_SEND
  58         ctype: mach_port_t;
  59 */
  60
  61
  62 /*
  63  * Connection management API's
  64  */
  65
  66 routine configopen      (       server          : mach_port_t;
  67                                 name            : xmlData;
  68                          out    session         : mach_port_move_send_t;
  69                          out    status          : int);
  70
  71 routine configclose     (       server          : mach_port_t;
  72                          out    status          : int);
  73
  74 routine configlock      (       server          : mach_port_t;
  75                          out    status          : int);
  76
  77 routine configunlock    (       server          : mach_port_t;
  78                          out    status          : int);
  79
  80         skip;   /* reserved for future use */
  81         skip;   /* reserved for future use */
  82         skip;   /* reserved for future use */
  83         skip;   /* reserved for future use */
  84
  85 /*
  86  * Dynamic store access API's
  87  */
  88
  89 routine configlist      (       server          : mach_port_t;
  90                                 xmlData         : xmlData;
  91                                 isRegex         : int;
  92                          out    list            : xmlDataOut, dealloc;
  93                          out    status          : int);
  94
  95 routine configadd       (       server          : mach_port_t;
  96                                 key             : xmlData;
  97                                 data            : xmlData;
  98                          out    newInstance     : int;
  99                          out    status          : int);
 100
 101 routine configget       (       server          : mach_port_t;
 102                                 key             : xmlData;
 103                          out    data            : xmlDataOut, dealloc;
 104                          out    newInstance     : int;
 105                          out    status          : int);
 106
 107 routine configset       (       server          : mach_port_t;
 108                                 key             : xmlData;
 109                                 data            : xmlData;
 110                                 instance        : int;
 111                          out    newInstance     : int;
 112                          out    status          : int);
 113
 114 routine configremove    (       server          : mach_port_t;
 115                                 key             : xmlData;
 116                          out    status          : int);
 117
 118 routine configtouch     (       server          : mach_port_t;
 119                                 key             : xmlData;
 120                          out    status          : int);
 121
 122 routine configadd_s     (       server          : mach_port_t;
 123                                 key             : xmlData;
 124                                 data            : xmlData;
 125                          out    newInstance     : int;
 126                          out    status          : int);
 127
 128 routine confignotify    (       server          : mach_port_t;
 129                                 key             : xmlData;
 130                          out    status          : int);
 131
 132 routine configget_m     (       server          : mach_port_t;
 133                                 keys            : xmlData;
 134                                 patterns        : xmlData;
 135                          out    data            : xmlDataOut, dealloc;
 136                          out    status          : int);
 137
 138 routine configset_m     (       server          : mach_port_t;
 139                                 data            : xmlData;
 140                                 remove          : xmlData;
 141                                 notify          : xmlData;
 142                          out    status          : int);
 143
 144 /*
 145  * Notification API's
 146  */
 147
 148 routine notifyadd       (       server          : mach_port_t;
 149                                 key             : xmlData;
 150                                 isRegex         : int;
 151                          out    status          : int);
 152
 153 routine notifyremove    (       server          : mach_port_t;
 154                                 key             : xmlData;
 155                                 isRegex         : int;
 156                          out    status          : int);
 157
 158 routine notifychanges   (       server          : mach_port_t;
 159                          out    list            : xmlDataOut, dealloc;
 160                          out    status          : int);
 161
 162 routine notifyviaport   (       server          : mach_port_t;
 163                                 port            : mach_port_move_send_t;
 164                                 msgid           : mach_msg_id_t;
 165                          out    status          : int);
 166
 167 routine notifyviafd     (       server          : mach_port_t;
 168                                 path            : xmlData;
 169                                 identifier      : int;
 170                          out    status          : int);
 171
 172 routine notifyviasignal (       server          : mach_port_t;
 173                                 task            : task_t /*task_move_send_t*/;
 174                                 sig             : int;
 175                          out    status          : int);
 176
 177 routine notifycancel    (       server          : mach_port_t;
 178                          out    status          : int);
 179
 180         skip;   /* reserved for future use */
 181         skip;   /* reserved for future use */
 182         skip;   /* reserved for future use */
 183         skip;   /* reserved for future use */
 184
 185 /*
 186  * Miscellaneous API's
 187  */
 188
 189 routine snapshot        (       server          : mach_port_t;
 190                          out    status          : int);