SystemConfiguration.fproj/VLANConfiguration.h

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