include/netlistmgr.idl

   1 /*
   2  * Copyright 2014 Hans Leidekker for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "oaidl.idl";
  20 import "objidl.idl";
  21
  22 #ifndef __WIDL__
  23 #define threading(model)
  24 #endif
  25
  26 interface IEnumNetworks;
  27 interface IEnumNetworkConnections;
  28 interface INetwork;
  29 interface INetworkConnection;
  30 interface INetworkCostManager;
  31 interface INetworkListManager;
  32
  33 typedef [v1_enum] enum NLM_CONNECTIVITY
  34 {
  35     NLM_CONNECTIVITY_DISCONNECTED      = 0x0000,
  36     NLM_CONNECTIVITY_IPV4_NOTRAFFIC    = 0x0001,
  37     NLM_CONNECTIVITY_IPV6_NOTRAFFIC    = 0x0002,
  38     NLM_CONNECTIVITY_IPV4_SUBNET       = 0x0010,
  39     NLM_CONNECTIVITY_IPV4_LOCALNETWORK = 0x0020,
  40     NLM_CONNECTIVITY_IPV4_INTERNET     = 0x0040,
  41     NLM_CONNECTIVITY_IPV6_SUBNET       = 0x0100,
  42     NLM_CONNECTIVITY_IPV6_LOCALNETWORK = 0x0200,
  43     NLM_CONNECTIVITY_IPV6_INTERNET     = 0x0400
  44 } NLM_CONNECTIVITY;
  45
  46 typedef [v1_enum] enum NLM_ENUM_NETWORK
  47 {
  48     NLM_ENUM_NETWORK_CONNECTED    = 0x01,
  49     NLM_ENUM_NETWORK_DISCONNECTED = 0x02,
  50     NLM_ENUM_NETWORK_ALL          = 0x03
  51 } NLM_ENUM_NETWORK;
  52
  53 typedef [v1_enum] enum NLM_CONNECTION_COST
  54 {
  55     NLM_CONNECTION_COST_UNKNOWN              = 0x0,
  56     NLM_CONNECTION_COST_UNRESTRICTED         = 0x1,
  57     NLM_CONNECTION_COST_FIXED                = 0x2,
  58     NLM_CONNECTION_COST_VARIABLE             = 0x4,
  59     NLM_CONNECTION_COST_OVERDATALIMIT        = 0x10000,
  60     NLM_CONNECTION_COST_CONGESTED            = 0x20000,
  61     NLM_CONNECTION_COST_ROAMING              = 0x40000,
  62     NLM_CONNECTION_COST_APPROACHINGDATALIMIT = 0x80000
  63 } NLM_CONNECTION_COST;
  64
  65 typedef struct NLM_SOCKADDR
  66 {
  67     BYTE data[128];
  68 } NLM_SOCKADDR;
  69
  70 typedef struct NLM_USAGE_DATA
  71 {
  72     DWORD    UsageInMegabytes;
  73     FILETIME LastSyncTime;
  74 } NLM_USAGE_DATA;
  75
  76 typedef struct NLM_DATAPLAN_STATUS
  77 {
  78     GUID           InterfaceGuid;
  79     NLM_USAGE_DATA UsageData;
  80     DWORD          DataLimitInMegabytes;
  81     DWORD          InboundBandwidthInKbps;
  82     DWORD          OutboundBandwidthInKbps;
  83     FILETIME       NextBillingCycle;
  84     DWORD          MaxTransferSizeInMegabytes;
  85     DWORD          Reserved;
  86 } NLM_DATAPLAN_STATUS;
  87
  88 [
  89     object,
  90     pointer_default(unique),
  91     uuid(dcb00008-570f-4a9b-8d69-199fdba5723b)
  92 ]
  93 interface INetworkCostManager : IUnknown
  94 {
  95     HRESULT GetCost(
  96         [out] DWORD *pCost,
  97         [in, unique] NLM_SOCKADDR *pDestIPAddr);
  98
  99     HRESULT GetDataPlanStatus(
 100         [out] NLM_DATAPLAN_STATUS *pDataPlanStatus,
 101         [in, unique] NLM_SOCKADDR *pDestIPAddr);
 102
 103     HRESULT SetDestinationAddresses(
 104         [in] UINT32 length,
 105         [in, unique, size_is(length)] NLM_SOCKADDR *pDestIPAddrList,
 106         [in] VARIANT_BOOL bAppend);
 107 }
 108
 109 [
 110     dual,
 111     object,
 112     oleautomation,
 113     pointer_default(unique),
 114     uuid(dcb00000-570f-4a9b-8d69-199fdba5723b)
 115 ]
 116 interface INetworkListManager : IDispatch
 117 {
 118     HRESULT GetNetworks(
 119         [in] NLM_ENUM_NETWORK Flags,
 120         [out, retval] IEnumNetworks **ppEnumNetwork);
 121
 122     HRESULT GetNetwork(
 123         [in] GUID gdNetworkId,
 124         [out, retval] INetwork **ppNetwork);
 125
 126     HRESULT GetNetworkConnections(
 127         [out, retval] IEnumNetworkConnections **ppEnum);
 128
 129     HRESULT GetNetworkConnection(
 130         [in] GUID gdNetworkConnectionId,
 131         [out, retval] INetworkConnection **ppNetworkConnection);
 132
 133     HRESULT IsConnectedToInternet(
 134         [out, retval] VARIANT_BOOL *pbIsConnected);
 135
 136     HRESULT IsConnected(
 137         [out, retval] VARIANT_BOOL *pbIsConnected);
 138
 139     HRESULT GetConnectivity(
 140         [out, retval] NLM_CONNECTIVITY *pConnectivity);
 141 }
 142
 143 [
 144     threading(both),
 145     uuid(dcb00c01-570f-4a9b-8d69-199fdba5723b)
 146 ]
 147 coclass NetworkListManager { interface INetworkListManager; }