SystemConfiguration.fproj/SCPrivate.h

   1 /*
   2  * Copyright (c) 2000-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 #ifndef _SCPRIVATE_H
  25 #define _SCPRIVATE_H
  26
  27 #include <sys/cdefs.h>
  28 #include <sys/socket.h>
  29 #include <sys/syslog.h>
  30 #include <mach/message.h>
  31
  32 #include <CoreFoundation/CoreFoundation.h>
  33
  34 #include <SystemConfiguration/SCDynamicStorePrivate.h>
  35 #include <SystemConfiguration/SCDynamicStoreCopySpecificPrivate.h>
  36 #include <SystemConfiguration/SCDynamicStoreSetSpecificPrivate.h>
  37
  38 #include <SystemConfiguration/SCPreferencesPrivate.h>
  39 #include <SystemConfiguration/SCPreferencesGetSpecificPrivate.h>
  40 #include <SystemConfiguration/SCPreferencesSetSpecificPrivate.h>
  41
  42 /*!
  43         @header SCPrivate
  44  */
  45
  46 /* framework variables */
  47 extern Boolean  _sc_debug;      /* TRUE if debugging enabled */
  48 extern Boolean  _sc_verbose;    /* TRUE if verbose logging enabled */
  49 extern Boolean  _sc_log;        /* TRUE if SCLog() output goes to syslog */
  50
  51 __BEGIN_DECLS
  52
  53 /*!
  54         @function _SCErrorSet
  55         @discussion Sets the last SystemConfiguration.framework API error code.
  56         @param error The error encountered.
  57  */
  58 void            _SCErrorSet                     (int                    error);
  59
  60 /*!
  61         @function _SCSerialize
  62         @discussion Serialize a CFPropertyList object for passing
  63                 to/from configd.
  64         @param obj CFPropertyList object to serialize
  65         @param xml A pointer to a CFDataRef, NULL if data should be
  66                 vm_allocated.
  67         @param dataRef A pointer to the newly allocated/serialized data
  68         @param dataLen A pointer to the length in bytes of the newly
  69                 allocated/serialized data
  70  */
  71 Boolean         _SCSerialize                    (CFPropertyListRef      obj,
  72                                                  CFDataRef              *xml,
  73                                                  void                   **dataRef,
  74                                                  CFIndex                *dataLen);
  75
  76 /*!
  77         @function _SCUnserialize
  78         @discussion Unserialize a stream of bytes passed from/to configd
  79                 into a CFPropertyList object.
  80         @param obj A pointer to memory that will be filled with the CFPropertyList
  81                 associated with the stream of bytes.
  82         @param xml CFDataRef with the serialized data
  83         @param dataRef A pointer to the serialized data
  84         @param dataLen A pointer to the length of the serialized data
  85
  86         Specify either "xml" or "data/dataLen".
  87  */
  88 Boolean         _SCUnserialize                  (CFPropertyListRef      *obj,
  89                                                  CFDataRef              xml,
  90                                                  void                   *dataRef,
  91                                                  CFIndex                dataLen);
  92
  93 /*!
  94         @function _SCSerializeString
  95         @discussion Serialize a CFString object for passing
  96                 to/from configd.
  97         @param str CFString key to serialize
  98         @param data A pointer to a CFDataRef, NULL if storage should be
  99                 vm_allocated.
 100         @param dataRef A pointer to the newly allocated/serialized data
 101         @param dataLen A pointer to the length in bytes of the newly
 102                 allocated/serialized data
 103  */
 104 Boolean         _SCSerializeString              (CFStringRef            str,
 105                                                  CFDataRef              *data,
 106                                                  void                   **dataRef,
 107                                                  CFIndex                *dataLen);
 108
 109 /*!
 110         @function _SCUnserializeString
 111         @discussion Unserialize a stream of bytes passed from/to configd
 112                 into a CFString object.
 113         @param str A pointer to memory that will be filled with the CFPropertyList
 114                 associated with the stream of bytes.
 115         @param utf8 CFDataRef with the serialized data
 116         @param dataRef A pointer to the serialized data
 117         @param dataLen A pointer to the length of the serialized data
 118
 119         Specify either "utf8" or "data/dataLen".
 120  */
 121 Boolean         _SCUnserializeString            (CFStringRef            *str,
 122                                                  CFDataRef              utf8,
 123                                                  void                   *dataRef,
 124                                                  CFIndex                dataLen);
 125
 126 /*!
 127         @function _SCSerializeData
 128         @discussion Serialize a CFData object for passing
 129                 to/from configd.
 130         @param data CFData key to serialize
 131         @param dataRef A pointer to the newly allocated/serialized data
 132         @param dataLen A pointer to the length in bytes of the newly
 133                 allocated/serialized data
 134  */
 135 Boolean         _SCSerializeData                (CFDataRef              data,
 136                                                  void                   **dataRef,
 137                                                  CFIndex                *dataLen);
 138
 139 /*!
 140         @function _SCUnserializeData
 141         @discussion Unserialize a stream of bytes passed from/to configd
 142                 into a CFData object.
 143         @param data A pointer to memory that will be filled with the CFPropertyList
 144                 associated with the stream of bytes.
 145         @param dataRef A pointer to the serialized data
 146         @param dataLen A pointer to the length of the serialized data
 147  */
 148 Boolean         _SCUnserializeData              (CFDataRef              *data,
 149                                                  void                   *dataRef,
 150                                                  CFIndex                dataLen);
 151
 152 /*!
 153         @function _SCSerializeMultiple
 154         @discussion Convert a CFDictionary containing a set of CFPropertlyList
 155                 values into a CFDictionary containing a set of serialized CFData
 156                 values.
 157         @param dict The CFDictionary with CFPropertyList values.
 158         @result The serialized CFDictionary with CFData values
 159  */
 160 CFDictionaryRef _SCSerializeMultiple            (CFDictionaryRef        dict);
 161
 162 /*!
 163         @function _SCUnserializeMultiple
 164         @discussion Convert a CFDictionary containing a set of CFData
 165                 values into a CFDictionary containing a set of serialized
 166                 CFPropertlyList  values.
 167         @param dict The CFDictionary with CFData values.
 168         @result The serialized CFDictionary with CFPropertyList values
 169  */
 170 CFDictionaryRef _SCUnserializeMultiple          (CFDictionaryRef        dict);
 171
 172 /*!
 173         @function _SC_cfstring_to_cstring
 174         @discussion Extracts a C-string from a CFString.
 175         @param cfstr The CFString to extract the data from.
 176         @param buf A user provided buffer of the specified length.  If NULL,
 177                 a new buffer will be allocated to contain the C-string.  It
 178                 is the responsiblity of the caller to free an allocated
 179                 buffer.
 180         @param bufLen The size of the user provided buffer.
 181         @param encoding The string encoding
 182         @result If the extraction (conversion) is successful then a pointer
 183                 to the user provided (or allocated) buffer is returned, NULL
 184                 if the string could not be extracted.
 185  */
 186 char *          _SC_cfstring_to_cstring         (CFStringRef            cfstr,
 187                                                  char                   *buf,
 188                                                  int                    bufLen,
 189                                                  CFStringEncoding       encoding);
 190
 191 /*!
 192  *      @function _SC_sockaddr_to_string
 193  *      @discussion Formats a "struct sockaddr" for reporting
 194  *      @param address The address to format
 195  *      @param buf A user provided buffer of the specified length.
 196  *      @param bufLen The size of the user provided buffer.
 197  */
 198 void            _SC_sockaddr_to_string          (const struct sockaddr  *address,
 199                                                  char                   *buf,
 200                                                  size_t                 bufLen);
 201
 202 /*!
 203         @function SCLog
 204         @discussion Conditionally issue a log message.
 205         @param condition A boolean value indicating if the message should be logged
 206         @param level A syslog(3) logging priority.
 207         @param formatString The format string
 208         @result The specified message will be written to the system message
 209                 logger (See syslogd(8)).
 210  */
 211 void            SCLog                           (Boolean                condition,
 212                                                  int                    level,
 213                                                  CFStringRef            formatString,
 214                                                  ...);
 215
 216 /*!
 217         @function SCPrint
 218         @discussion Conditionally issue a debug message.
 219         @param condition A boolean value indicating if the message should be written
 220         @param stream The output stream for the log message.
 221         @param formatString The format string
 222         @result The message will be written to the specified stream
 223                 stream.
 224  */
 225 void            SCPrint                         (Boolean                condition,
 226                                                  FILE                   *stream,
 227                                                  CFStringRef            formatString,
 228                                                  ...);
 229
 230 /*!
 231         @function SCTrace
 232         @discussion Conditionally issue a debug message with a time stamp.
 233         @param condition A boolean value indicating if the message should be written
 234         @param stream The output stream for the log message.
 235         @param formatString The format string
 236         @result The message will be written to the specified stream
 237                 stream.
 238  */
 239 void            SCTrace                         (Boolean                condition,
 240                                                  FILE                   *stream,
 241                                                  CFStringRef            formatString,
 242                                                  ...);
 243
 244 /*
 245  * object / CFRunLoop  management
 246  */
 247 void
 248 _SC_signalRunLoop                               (CFTypeRef              obj,
 249                                                  CFRunLoopSourceRef     rls,
 250                                                  CFArrayRef             rlList);
 251
 252 Boolean
 253 _SC_isScheduled                                 (CFTypeRef              obj,
 254                                                  CFRunLoopRef           runLoop,
 255                                                  CFStringRef            runLoopMode,
 256                                                  CFMutableArrayRef      rlList);
 257
 258 void
 259 _SC_schedule                                    (CFTypeRef              obj,
 260                                                  CFRunLoopRef           runLoop,
 261                                                  CFStringRef            runLoopMode,
 262                                                  CFMutableArrayRef      rlList);
 263
 264 Boolean
 265 _SC_unschedule                                  (CFTypeRef              obj,
 266                                                  CFRunLoopRef           runLoop,
 267                                                  CFStringRef            runLoopMode,
 268                                                  CFMutableArrayRef      rlList,
 269                                                  Boolean                all);
 270
 271 __END_DECLS
 272
 273 #endif  /* _SCPRIVATE_H */