scutil.tproj/net.h

   1 /*
   2  * Copyright (c) 2004, 2006, 2011, 2014, 2016, 2019, 2020 Apple 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  * August 5, 2004                       Allan Nathanson <ajn@apple.com>
  28  * - initial revision
  29  */
  30
  31 #ifndef _NET_H
  32 #define _NET_H
  33
  34 #include <sys/cdefs.h>
  35
  36 #include <CoreFoundation/CoreFoundation.h>
  37 #include <SystemConfiguration/SystemConfiguration.h>
  38
  39
  40 typedef int (*optionHandler) (CFStringRef               key,
  41                               const char                *description,
  42                               void                      *info,
  43                               int                       argc,
  44                               char                      **argv,
  45                               CFMutableDictionaryRef    newConfiguration);
  46
  47 typedef enum {
  48         isOther,                // use "only" handler function for processing
  49         isHelp,
  50         isChooseOne,
  51         isChooseMultiple,
  52         isBool,                 // CFBoolean
  53         isBoolean,              // CFNumber (0 or 1)
  54         isNumber,               // CFNumber
  55         isString,               // CFString
  56         isStringArray           // CFArray[CFString]
  57 } optionType;
  58
  59 typedef const struct {
  60         const CFStringRef       selection;
  61         const CFStringRef       *key;
  62         const unsigned int      flags;
  63 } selections;
  64 #define selectionNotAvailable   1<<0    // if you can't "choose" this selection
  65
  66 typedef const struct {
  67         const char              *option;
  68         const char              *description;
  69         optionType              type;
  70         const CFStringRef       *key;
  71         optionHandler           handler;
  72         void                    *info;
  73 } options, *optionsRef;
  74
  75
  76 extern CFMutableArrayRef        new_interfaces;
  77
  78 extern CFArrayRef               interfaces;
  79 extern CFArrayRef               services;
  80 extern CFArrayRef               protocols;
  81 extern CFArrayRef               sets;
  82
  83 extern SCNetworkInterfaceRef    net_interface;
  84 extern SCNetworkServiceRef      net_service;
  85 extern SCNetworkProtocolRef     net_protocol;
  86 extern SCNetworkSetRef          net_set;
  87
  88 extern CFNumberRef              CFNumberRef_0;
  89 extern CFNumberRef              CFNumberRef_1;
  90
  91
  92 __BEGIN_DECLS
  93
  94 Boolean         _process_options(optionsRef             options,
  95                                  int                    nOptions,
  96                                  int                    argc,
  97                                  char                   **argv,
  98                                  CFMutableDictionaryRef newConfiguration);
  99
 100 CF_RETURNS_RETAINED
 101 CFNumberRef     _copy_number    (const char *arg);
 102
 103 CFIndex         _find_option    (const char     *option,
 104                                  optionsRef     options,
 105                                  const int      nOptions);
 106
 107 CFIndex         _find_selection (CFStringRef    choice,
 108                                  selections     choises[],
 109                                  unsigned int   *flags);
 110
 111 void            _show_entity    (CFDictionaryRef entity, CFStringRef prefix);
 112
 113 void            do_net_init     (void);
 114 void            do_net_quit     (int argc, char **argv);
 115
 116 void            do_net_open     (int argc, char **argv);
 117 void            do_net_commit   (int argc, char **argv);
 118 void            do_net_apply    (int argc, char **argv);
 119 void            do_net_close    (int argc, char **argv);
 120
 121 void            do_net_clean    (int argc, char **argv);
 122 void            do_net_create   (int argc, char **argv);
 123 void            do_net_disable  (int argc, char **argv);
 124 void            do_net_enable   (int argc, char **argv);
 125 void            do_net_migrate  (int argc, char **argv);
 126 void            do_net_remove   (int argc, char **argv);
 127 void            do_net_select   (int argc, char **argv);
 128 void            do_net_set      (int argc, char **argv);
 129 void            do_net_show     (int argc, char **argv);
 130 void            do_net_update   (int argc, char **argv);
 131 void            do_net_upgrade  (int argc, char **argv);
 132
 133 void            do_net_snapshot (int argc, char **argv);
 134
 135 __END_DECLS
 136
 137 #endif /* !_NET_H */