SystemConfiguration.fproj/SCDynamicStoreCopyDHCPInfo.h

   1 /*
   2  * Copyright (c) 2001, 2002, 2004, 2005, 2008, 2012, 2015 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 #ifndef _SCDYNAMICSTORECOPYDHCPINFO_H
  25 #ifdef  USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS
  26 #include <SystemConfiguration/_SCDynamicStoreCopyDHCPInfo.h>
  27 #else   /* USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS */
  28 #define _SCDYNAMICSTORECOPYDHCPINFO_H
  29
  30 #include <Availability.h>
  31 #include <sys/cdefs.h>
  32 #include <CoreFoundation/CoreFoundation.h>
  33 #include <SystemConfiguration/SCDynamicStore.h>
  34
  35 CF_IMPLICIT_BRIDGING_ENABLED
  36 CF_ASSUME_NONNULL_BEGIN
  37
  38 /*!
  39         @header SCDynamicStoreCopyDHCPInfo
  40         @discussion The functions of the SCDynamicStoreCopyDHCPInfo API
  41                 provide access to information returned by the DHCP or
  42                 BOOTP server.
  43  */
  44
  45
  46 __BEGIN_DECLS
  47
  48 /*!
  49         @function SCDynamicStoreCopyDHCPInfo
  50         @discussion Copies the DHCP information for the requested serviceID,
  51                 or the primary service if serviceID == NULL.
  52         @param store An SCDynamicStoreRef representing the dynamic store session
  53                 that should be used for communication with the server.
  54                 If NULL, a temporary session will be used.
  55         @param serviceID A CFStringRef containing the requested service.
  56                 If NULL, returns information for the primary service.
  57         @result Returns a dictionary containing DHCP information if successful;
  58                 NULL otherwise.
  59                 Use the DHCPInfoGetOption function to retrieve
  60                 individual options from the returned dictionary.
  61
  62                 A non-NULL return value must be released using CFRelease().
  63  */
  64 CFDictionaryRef __nullable
  65 SCDynamicStoreCopyDHCPInfo      (SCDynamicStoreRef      __nullable      store,
  66                                  CFStringRef            __nullable      serviceID)      __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  67
  68 /*!
  69         @function DHCPInfoGetOptionData
  70         @discussion Returns a non-NULL CFDataRef containing the DHCP
  71                 option data, if present.
  72         @param info The non-NULL DHCP information dictionary returned by
  73                 calling SCDynamicStoreCopyDHCPInfo.
  74         @param code The DHCP option code (see RFC 2132) to return
  75                 data for.
  76         @result Returns a non-NULL CFDataRef containing the option data;
  77                 NULL if the requested option data is not present.
  78
  79                 The return value must NOT be released.
  80  */
  81 CFDataRef __nullable
  82 DHCPInfoGetOptionData           (CFDictionaryRef        info,
  83                                  UInt8                  code)           __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  84
  85 /*!
  86         @function DHCPInfoGetLeaseStartTime
  87         @discussion Returns a CFDateRef corresponding to the lease start time,
  88                 if present.
  89         @param info The non-NULL DHCP information dictionary returned by
  90                 calling SCDynamicStoreCopyDHCPInfo.
  91         @result Returns a non-NULL CFDateRef if lease start time information is
  92                 present; NULL if the information is not present or if the
  93                 configuration method is not DHCP.
  94
  95                 The return value must NOT be released.
  96  */
  97 CFDateRef __nullable
  98 DHCPInfoGetLeaseStartTime       (CFDictionaryRef        info)           __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0/*SPI*/);
  99
 100
 101 /*!
 102         @function DHCPInfoGetLeaseExpirationTime
 103         @discussion Returns a CFDateRef corresponding to the lease expiration time,
 104                 if present.
 105         @param info The non-NULL DHCP information dictionary returned by
 106                 calling SCDynamicStoreCopyDHCPInfo.
 107         @result Returns a non-NULL CFDateRef if the DHCP lease has an expiration;
 108                 NULL if the lease is infinite i.e. has no expiration, or the
 109                 configuration method is not DHCP. An infinite lease can be determined
 110                 by a non-NULL lease start time (see DHCPInfoGetLeaseStartTime above).
 111
 112                 The return value must NOT be released.
 113 */
 114 CFDateRef __nullable
 115 DHCPInfoGetLeaseExpirationTime  (CFDictionaryRef        info)           __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0/*SPI*/);
 116
 117 __END_DECLS
 118
 119 CF_ASSUME_NONNULL_END
 120 CF_IMPLICIT_BRIDGING_DISABLED
 121
 122 #endif  /* USE_SYSTEMCONFIGURATION_PRIVATE_HEADERS */
 123 #endif  /* _SCDYNAMICSTORECOPYDHCPINFO_H */