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 interface INetworkListManagerEvents;
  33
  34 typedef [v1_enum] enum NLM_CONNECTIVITY
  35 {
  36     NLM_CONNECTIVITY_DISCONNECTED      = 0x0000,
  37     NLM_CONNECTIVITY_IPV4_NOTRAFFIC    = 0x0001,
  38     NLM_CONNECTIVITY_IPV6_NOTRAFFIC    = 0x0002,
  39     NLM_CONNECTIVITY_IPV4_SUBNET       = 0x0010,
  40     NLM_CONNECTIVITY_IPV4_LOCALNETWORK = 0x0020,
  41     NLM_CONNECTIVITY_IPV4_INTERNET     = 0x0040,
  42     NLM_CONNECTIVITY_IPV6_SUBNET       = 0x0100,
  43     NLM_CONNECTIVITY_IPV6_LOCALNETWORK = 0x0200,
  44     NLM_CONNECTIVITY_IPV6_INTERNET     = 0x0400
  45 } NLM_CONNECTIVITY;
  46
  47 typedef [v1_enum] enum NLM_ENUM_NETWORK
  48 {
  49     NLM_ENUM_NETWORK_CONNECTED    = 0x01,
  50     NLM_ENUM_NETWORK_DISCONNECTED = 0x02,
  51     NLM_ENUM_NETWORK_ALL          = 0x03
  52 } NLM_ENUM_NETWORK;
  53
  54 typedef [v1_enum] enum NLM_CONNECTION_COST
  55 {
  56     NLM_CONNECTION_COST_UNKNOWN              = 0x0,
  57     NLM_CONNECTION_COST_UNRESTRICTED         = 0x1,
  58     NLM_CONNECTION_COST_FIXED                = 0x2,
  59     NLM_CONNECTION_COST_VARIABLE             = 0x4,
  60     NLM_CONNECTION_COST_OVERDATALIMIT        = 0x10000,
  61     NLM_CONNECTION_COST_CONGESTED            = 0x20000,
  62     NLM_CONNECTION_COST_ROAMING              = 0x40000,
  63     NLM_CONNECTION_COST_APPROACHINGDATALIMIT = 0x80000
  64 } NLM_CONNECTION_COST;
  65
  66 typedef struct NLM_SOCKADDR
  67 {
  68     BYTE data[128];
  69 } NLM_SOCKADDR;
  70
  71 typedef struct NLM_USAGE_DATA
  72 {
  73     DWORD    UsageInMegabytes;
  74     FILETIME LastSyncTime;
  75 } NLM_USAGE_DATA;
  76
  77 typedef struct NLM_DATAPLAN_STATUS
  78 {
  79     GUID           InterfaceGuid;
  80     NLM_USAGE_DATA UsageData;
  81     DWORD          DataLimitInMegabytes;
  82     DWORD          InboundBandwidthInKbps;
  83     DWORD          OutboundBandwidthInKbps;
  84     FILETIME       NextBillingCycle;
  85     DWORD          MaxTransferSizeInMegabytes;
  86     DWORD          Reserved;
  87 } NLM_DATAPLAN_STATUS;
  88
  89 [
  90     object,
  91     pointer_default(unique),
  92     uuid(dcb00008-570f-4a9b-8d69-199fdba5723b)
  93 ]
  94 interface INetworkCostManager : IUnknown
  95 {
  96     HRESULT GetCost(
  97         [out] DWORD *pCost,
  98         [in, unique] NLM_SOCKADDR *pDestIPAddr);
  99
 100     HRESULT GetDataPlanStatus(
 101         [out] NLM_DATAPLAN_STATUS *pDataPlanStatus,
 102         [in, unique] NLM_SOCKADDR *pDestIPAddr);
 103
 104     HRESULT SetDestinationAddresses(
 105         [in] UINT32 length,
 106         [in, unique, size_is(length)] NLM_SOCKADDR *pDestIPAddrList,
 107         [in] VARIANT_BOOL bAppend);
 108 }
 109
 110 [
 111     dual,
 112     object,
 113     oleautomation,
 114     pointer_default(unique),
 115     uuid(dcb00000-570f-4a9b-8d69-199fdba5723b)
 116 ]
 117 interface INetworkListManager : IDispatch
 118 {
 119     HRESULT GetNetworks(
 120         [in] NLM_ENUM_NETWORK Flags,
 121         [out, retval] IEnumNetworks **ppEnumNetwork);
 122
 123     HRESULT GetNetwork(
 124         [in] GUID gdNetworkId,
 125         [out, retval] INetwork **ppNetwork);
 126
 127     HRESULT GetNetworkConnections(
 128         [out, retval] IEnumNetworkConnections **ppEnum);
 129
 130     HRESULT GetNetworkConnection(
 131         [in] GUID gdNetworkConnectionId,
 132         [out, retval] INetworkConnection **ppNetworkConnection);
 133
 134     HRESULT IsConnectedToInternet(
 135         [out, retval] VARIANT_BOOL *pbIsConnected);
 136
 137     HRESULT IsConnected(
 138         [out, retval] VARIANT_BOOL *pbIsConnected);
 139
 140     HRESULT GetConnectivity(
 141         [out, retval] NLM_CONNECTIVITY *pConnectivity);
 142 }
 143
 144 [
 145     threading(both),
 146     uuid(dcb00c01-570f-4a9b-8d69-199fdba5723b)
 147 ]
 148 coclass NetworkListManager { interface INetworkListManager; }
 149
 150 [
 151     object,
 152     oleautomation,
 153     pointer_default(unique),
 154     uuid(DCB00001-570F-4A9B-8D69-199FDBA5723B)
 155 ]
 156 interface INetworkListManagerEvents : IUnknown
 157 {
 158     HRESULT ConnectivityChanged(
 159         [in] NLM_CONNECTIVITY newConnectivity);
 160 }