IPMonitorControl/IPMonitorAWDReport.h

   1 /*
   2  * Copyright (c) 2018 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  * IPMonitorAWDReport.h
  26  * - C shim layer to interact with AWD to generate and submit a metric
  27  */
  28
  29 #ifndef _S_IPMONITOR_AWD_REPORT_H
  30 #define _S_IPMONITOR_AWD_REPORT_H
  31
  32 /*
  33  * Modification History
  34  *
  35  * June 21, 2018        Dieter Siegmund (dieter@apple.com)
  36  * - created
  37  */
  38
  39 #include <CoreFoundation/CFBase.h>
  40 #ifndef NS_ENUM
  41 #define NS_ENUM         CF_ENUM
  42 #endif
  43
  44 #include "AWDIPMonitorGlobalEnums.h"
  45
  46 /* ugh, duplicate */
  47 #ifndef __OBJC__
  48 typedef NS_ENUM(int32_t, AWDIPMonitorInterfaceAdvisoryReport_Flags) {
  49     AWDIPMonitorInterfaceAdvisoryReport_Flags_LINK_LAYER_ISSUE = 1,
  50     AWDIPMonitorInterfaceAdvisoryReport_Flags_UPLINK_ISSUE = 2,
  51 };
  52 #endif
  53
  54 typedef CFTypeRef InterfaceAdvisoryReportRef;
  55
  56 InterfaceAdvisoryReportRef
  57 InterfaceAdvisoryReportCreate(AWDIPMonitorInterfaceType type);
  58
  59 void
  60 InterfaceAdvisoryReportSubmit(InterfaceAdvisoryReportRef report);
  61
  62 void
  63 InterfaceAdvisoryReportSetFlags(InterfaceAdvisoryReportRef report,
  64                                 AWDIPMonitorInterfaceAdvisoryReport_Flags flags);
  65 void
  66 InterfaceAdvisoryReportSetAdvisoryCount(InterfaceAdvisoryReportRef report,
  67                                         uint32_t count);
  68 #endif /*  _S_IPMONITOR_AWD_REPORT_H */