SystemConfiguration.fproj/VLANConfiguration.h

   1 /*
   2  * Copyright (c) 2003 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 _VLANCONFIGURATION_H
  25 #define _VLANCONFIGURATION_H
  26
  27
  28 #include <sys/cdefs.h>
  29 #include <CoreFoundation/CoreFoundation.h>
  30
  31
  32 typedef const struct __VLANInterface *          VLANInterfaceRef;
  33
  34 typedef const struct __VLANPreferences *        VLANPreferencesRef;
  35
  36
  37 __BEGIN_DECLS
  38
  39 // ----------
  40
  41 Boolean
  42 IsVLANSupported                 (CFStringRef            device);        // e.g. "en0", "en1", ...
  43
  44 // ----------
  45
  46 CFTypeID
  47 VLANInterfaceGetTypeID          (void);
  48
  49 CFStringRef
  50 VLANInterfaceGetInterface       (VLANInterfaceRef       vlan);  // returns "vlan0", "vlan1", ...
  51
  52 CFStringRef
  53 VLANInterfaceGetDevice          (VLANInterfaceRef       vlan);  // returns "en0", "en1, ...
  54
  55 CFNumberRef
  56 VLANInterfaceGetTag             (VLANInterfaceRef       vlan);  // returns 1 <= tag <= 4094
  57
  58 CFDictionaryRef
  59 VLANInterfaceGetOptions         (VLANInterfaceRef       vlan);  // e.g. UserDefinedName, ...
  60
  61 // ----------
  62
  63 CFTypeID
  64 VLANPreferencesGetTypeID        (void);
  65
  66 VLANPreferencesRef
  67 VLANPreferencesCreate           (CFAllocatorRef         allocator);
  68
  69 CFArrayRef /* of VLANInterfaceRef's */
  70 VLANPreferencesCopyInterfaces   (VLANPreferencesRef     prefs);
  71
  72 VLANInterfaceRef
  73 VLANPreferencesAddInterface     (VLANPreferencesRef     prefs,
  74                                  CFStringRef            device,         // e.g. "en0", "en1", ...
  75                                  CFNumberRef            tag,            // e.g. 1 <= tag <= 4094
  76                                  CFDictionaryRef        options);       // e.g. UserDefinedName, ...
  77
  78 Boolean
  79 VLANPreferencesUpdateInterface  (VLANPreferencesRef     prefs,
  80                                  VLANInterfaceRef       vlan,
  81                                  CFStringRef            newDevice,
  82                                  CFNumberRef            newTag,
  83                                  CFDictionaryRef        newOptions);
  84
  85 Boolean
  86 VLANPreferencesRemoveInterface  (VLANPreferencesRef     prefs,
  87                                  VLANInterfaceRef       vlan);
  88
  89 Boolean
  90 VLANPreferencesCommitChanges    (VLANPreferencesRef     prefs);
  91
  92 Boolean
  93 VLANPreferencesApplyChanges     (VLANPreferencesRef     prefs);
  94
  95 // ----------
  96
  97 __END_DECLS
  98
  99 #endif /* _VLANCONFIGURATION_H */