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