Routprot.h
上传用户:dzyhzl
上传日期:2019-04-29
资源大小:56270k
文件大小:22k
源码类别:

模拟服务器

开发平台:

C/C++

  1. //depot/private/homenet/net/published/inc/routprot.w#2 - integrate change 4116 (text)
  2. /*++
  3. Copyright (c) Microsoft Corporation. All rights reserved.
  4. Module Name:
  5.     routprot.h
  6. Abstract:
  7.     Include file for Routing Protocol inteface to Router Managers
  8. --*/
  9. #ifndef _ROUTPROT_H_
  10. #define _ROUTPROT_H_
  11. #if _MSC_VER > 1000
  12. #pragma once
  13. #endif
  14. #include "stm.h"
  15. #if _MSC_VER >= 1200
  16. #pragma warning(push)
  17. #endif
  18. #pragma warning(disable:4201)
  19. #pragma warning(disable:4200)
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif
  23. //////////////////////////////////////////////////////////////////////////////
  24. //                                                                          //
  25. // Supported functionality flags                                            //
  26. //                                                                          //
  27. // ROUTING              Imports Routing Table Manager APIs              //
  28. // SERVICES             Exports Service Table Manager APIs              //
  29. // DEMAND_UPDATE_ROUTES     IP and IPX RIP support for Autostatic           //
  30. // DEMAND_UPDATE_SERVICES   IPX SAP, NLSP support for Autostatic            //
  31. // ADD_ALL_INTERFACES       Adds all interfaces, even if no info is present //
  32. // MULTICAST                Supports multicast                              //
  33. // POWER                    Power Manageable                                //
  34. //                                                                          //
  35. //////////////////////////////////////////////////////////////////////////////
  36. #define RF_ROUTING          0x00000001
  37. #define RF_DEMAND_UPDATE_ROUTES 0x00000004
  38. #define RF_ADD_ALL_INTERFACES   0x00000010
  39. #define RF_MULTICAST            0x00000020
  40. #define RF_POWER                0x00000040
  41. #if MPR50
  42. #define MS_ROUTER_VERSION       0x00000500
  43. #else
  44. #error Router version not defined
  45. #endif
  46. typedef enum _ROUTING_PROTOCOL_EVENTS
  47. {
  48.     ROUTER_STOPPED,              // Result is empty
  49.     SAVE_GLOBAL_CONFIG_INFO,     // Result is empty
  50.     SAVE_INTERFACE_CONFIG_INFO,  // Result is interface index
  51.                                  // for which config info is to be saved.
  52.     UPDATE_COMPLETE,             // Result is UPDATE_COMPLETE_MESSAGE structure
  53. }ROUTING_PROTOCOL_EVENTS;
  54. typedef enum _NET_INTERFACE_TYPE
  55. {
  56.     PERMANENT,
  57.     DEMAND_DIAL,
  58.     LOCAL_WORKSTATION_DIAL,
  59.     REMOTE_WORKSTATION_DIAL
  60. } NET_INTERFACE_TYPE;
  61. //
  62. // Interface Receive Types
  63. //
  64. #define IR_PROMISCUOUS                  0
  65. #define IR_PROMISCUOUS_MULTICAST        1
  66. typedef struct _SUPPORT_FUNCTIONS
  67. {
  68.     union
  69.     {
  70.         ULONGLONG   _Align8;
  71.         struct
  72.         {
  73.             DWORD   dwVersion;
  74.             DWORD   dwReserved;
  75.         };
  76.     };
  77.     //
  78.     // Function called by routing protocol to initiate demand dial connection
  79.     //
  80.     OUT DWORD
  81.     (WINAPI *DemandDialRequest)(
  82.         IN      DWORD           ProtocolId,
  83.         IN      DWORD           InterfaceIndex
  84.         ) ;
  85.     //
  86.     // Can be called to set the interface's receive capability
  87.     // See IR_Xxx values above
  88.     //
  89.     OUT DWORD
  90.     (WINAPI *SetInterfaceReceiveType)(
  91.         IN      DWORD           ProtocolId,
  92.         IN      DWORD           InterfaceIndex,
  93.         IN      DWORD           InterfaceReceiveType,
  94.         IN      BOOL            bActivate
  95.         );
  96.     //
  97.     // Must be called by every protocol to set the route preference
  98.     // and perform other validation
  99.     //
  100.     OUT DWORD
  101.     (WINAPI *ValidateRoute)(
  102.         IN      DWORD           ProtocolId,
  103.         IN      PVOID           RouteInfo,
  104.         IN      PVOID           DestAddress OPTIONAL
  105.         );
  106.     //
  107.     // The following entrypoints are provided as a way for getting
  108.     // information that spans components
  109.     //
  110.     OUT DWORD
  111.     (WINAPI *MIBEntryCreate)(
  112.         IN      DWORD           dwRoutingPid,
  113.         IN      DWORD           dwEntrySize,
  114.         IN      LPVOID          lpEntry
  115.         );
  116.     OUT DWORD
  117.     (WINAPI *MIBEntryDelete)(
  118.         IN      DWORD           dwRoutingPid,
  119.         IN      DWORD           dwEntrySize,
  120.         IN      LPVOID          lpEntry
  121.         );
  122.     OUT DWORD
  123.     (WINAPI *MIBEntrySet)(
  124.         IN      DWORD           dwRoutingPid,
  125.         IN      DWORD           dwEntrySize,
  126.         IN      LPVOID          lpEntry
  127.         );
  128.     OUT DWORD
  129.     (WINAPI *MIBEntryGet)(
  130.         IN      DWORD           dwRoutingPid,
  131.         IN      DWORD           dwInEntrySize,
  132.         IN      LPVOID          lpInEntry,
  133.         IN OUT  LPDWORD         lpOutEntrySize,
  134.         OUT     LPVOID          lpOutEntry
  135.         );
  136.     OUT DWORD
  137.     (WINAPI *MIBEntryGetFirst)(
  138.         IN      DWORD           dwRoutingPid,
  139.         IN      DWORD           dwInEntrySize,
  140.         IN      LPVOID          lpInEntry,
  141.         IN OUT  LPDWORD         lpOutEntrySize,
  142.         OUT     LPVOID          lpOutEntry
  143.         );
  144.     OUT DWORD
  145.     (WINAPI *MIBEntryGetNext)(
  146.         IN      DWORD           dwRoutingPid,
  147.         IN      DWORD           dwInEntrySize,
  148.         IN      LPVOID          lpInEntry,
  149.         IN OUT  LPDWORD         lpOutEntrySize,
  150.         OUT     LPVOID          lpOutEntry
  151.         );
  152.     //
  153.     // Can be called to get the router ID value
  154.     //
  155.     OUT DWORD
  156.     (WINAPI *GetRouterId)(VOID);
  157.     OUT BOOL
  158.     (WINAPI *HasMulticastBoundary)(
  159.         IN      DWORD           dwIfIndex,
  160.         IN      DWORD           dwGroupAddress
  161.         );
  162. } SUPPORT_FUNCTIONS, *PSUPPORT_FUNCTIONS ;
  163. //////////////////////////////////////////////////////////////////////////////
  164. //                                                                          //
  165. // All IP Protocols must use the protocol ids defined in the range below.   //
  166. // Protocols not identified below can use any unassigned number BELOW       //
  167. // 0xffff0000                                                               //
  168. //                                                                          //
  169. // NOTE: These numbers have been chosen to coincide with MIB-II protocol    //
  170. // numbers. Allocation should not be arbitrary.                             //
  171. //                                                                          //
  172. //////////////////////////////////////////////////////////////////////////////
  173. #define PROTO_IP_OTHER      1
  174. #define PROTO_IP_LOCAL      2
  175. #define PROTO_IP_NETMGMT    3
  176. #define PROTO_IP_ICMP       4
  177. #define PROTO_IP_EGP        5
  178. #define PROTO_IP_GGP        6
  179. #define PROTO_IP_HELLO      7
  180. #define PROTO_IP_RIP        8
  181. #define PROTO_IP_IS_IS      9
  182. #define PROTO_IP_ES_IS      10
  183. #define PROTO_IP_CISCO      11
  184. #define PROTO_IP_BBN        12
  185. #define PROTO_IP_OSPF       13
  186. #define PROTO_IP_BGP        14
  187. //
  188. // The multicast protocol IDs
  189. //
  190. #define PROTO_IP_MSDP        9
  191. #define PROTO_IP_IGMP       10
  192. #define PROTO_IP_BGMP       11
  193. //
  194. // The IPRTRMGR_PID is 10000 // 0x00002710
  195. //
  196. #define PROTO_IP_VRRP               112
  197. #define PROTO_IP_BOOTP              9999    // 0x0000270F
  198. #define PROTO_IP_NT_AUTOSTATIC      10002   // 0x00002712
  199. #define PROTO_IP_DNS_PROXY          10003   // 0x00002713
  200. #define PROTO_IP_DHCP_ALLOCATOR     10004   // 0x00002714
  201. #define PROTO_IP_NAT                10005   // 0x00002715
  202. #define PROTO_IP_NT_STATIC          10006   // 0x00002716
  203. #define PROTO_IP_NT_STATIC_NON_DOD  10007   // 0x00002717
  204. #define PROTO_IP_DIFFSERV           10008   // 0x00002718
  205. #define PROTO_IP_MGM                10009   // 0x00002719
  206. #define PROTO_IP_DTP                10010   // 0x0000271A
  207. #define PROTO_IP_H323               10011   // 0x0000271B
  208. #define PROTO_IP_FTP                10012   // 0x0000271C
  209. #define PROTO_IP_ALG                10013   // 0x0000271D
  210. //
  211. // For all future development, the following macro must be used to generate
  212. // Ids
  213. //
  214. //
  215. //  Type            -   2 bits
  216. //  Vendor          -  14 bits
  217. //  ProtocolId      -  16 bits
  218. //
  219. #define PROTOCOL_ID(Type, VendorId, ProtocolId) 
  220.     (((Type & 0x03)<<30)|((VendorId & 0x3FFF)<<16)|(ProtocolId & 0xFFFF))
  221. //
  222. //  |----|----|----|----|----|----|----|----|
  223. //   Ty*** Vendor Id *** StandardProtocolId
  224. //
  225. #define TYPE_FROM_PROTO_ID(X)       (((X) >> 30) & 0x03)
  226. #define VENDOR_FROM_PROTO_ID(X)     (((X) >> 16) & 0x3FFF)
  227. #define PROTO_FROM_PROTO_ID(X)      ((X) & 0xFFFF)
  228. //
  229. // Types MS0 and MS1 are Microsoft Reserved
  230. // A protocol that supports both unicast and multicast should use type
  231. // MCAST
  232. //
  233. #define PROTO_TYPE_UCAST            0
  234. #define PROTO_TYPE_MCAST            1
  235. #define PROTO_TYPE_MS0              2
  236. #define PROTO_TYPE_MS1              3
  237. #define PROTO_VENDOR_MS0            0x0000
  238. #define PROTO_VENDOR_MS1            0x137   // 311
  239. #define PROTO_VENDOR_MS2            0x3FFF
  240. #define MS_IP_BOOTP                 
  241.     PROTOCOL_ID(PROTO_TYPE_UCAST, PROTO_VENDOR_MS0, PROTO_IP_BOOTP)
  242. #define MS_IP_RIP                   
  243.     PROTOCOL_ID(PROTO_TYPE_UCAST, PROTO_VENDOR_MS0, PROTO_IP_RIP)
  244. #define MS_IP_OSPF                  
  245.     PROTOCOL_ID(PROTO_TYPE_UCAST, PROTO_VENDOR_MS0, PROTO_IP_OSPF)
  246. #define MS_IP_BGP                   
  247.     PROTOCOL_ID(PROTO_TYPE_UCAST, PROTO_VENDOR_MS1, PROTO_IP_BGP)
  248. #define MS_IP_IGMP                  
  249.     PROTOCOL_ID(PROTO_TYPE_MCAST, PROTO_VENDOR_MS1, PROTO_IP_IGMP)
  250. #define MS_IP_BGMP                  
  251.     PROTOCOL_ID(PROTO_TYPE_MCAST, PROTO_VENDOR_MS1, PROTO_IP_BGMP)
  252. #define MS_IP_MSDP                  
  253.     PROTOCOL_ID(PROTO_TYPE_MCAST, PROTO_VENDOR_MS1, PROTO_IP_MSDP)
  254. #define MS_IP_DNS_PROXY             
  255.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_DNS_PROXY)
  256. #define MS_IP_DHCP_ALLOCATOR        
  257.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_DHCP_ALLOCATOR)
  258. #define MS_IP_NAT                   
  259.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_NAT)
  260. #define MS_IP_DIFFSERV              
  261.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_DIFFSERV)
  262. #define MS_IP_MGM                   
  263.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_MGM)
  264. #define MS_IP_VRRP                  
  265.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_VRRP)
  266. #define MS_IP_DTP                   
  267.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_DTP)
  268. #define MS_IP_H323                  
  269.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_H323)
  270. #define MS_IP_FTP                   
  271.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_FTP)
  272. #define MS_IP_ALG                   
  273.     PROTOCOL_ID(PROTO_TYPE_MS0, PROTO_VENDOR_MS1, PROTO_IP_ALG)
  274. //
  275. // All IPX Protocols must use the protocol ids defined in the range below.
  276. // Protocols not identified below can use any unassigned number greater than
  277. // IPX_PROTOCOL_BASE.
  278. //
  279. #define IPX_PROTOCOL_BASE   0x0001ffff
  280. #define IPX_PROTOCOL_RIP    IPX_PROTOCOL_BASE + 1
  281. #define IPX_PROTOCOL_SAP    IPX_PROTOCOL_BASE + 2
  282. #define IPX_PROTOCOL_NLSP   IPX_PROTOCOL_BASE + 3
  283. typedef struct _UPDATE_COMPLETE_MESSAGE
  284. {
  285.     ULONG InterfaceIndex;
  286.     ULONG UpdateType;        // DEMAND_UPDATE_ROUTES, DEMAND_UPDATE_SERVICES
  287.     ULONG UpdateStatus;    // NO_ERROR if successfull
  288. }   UPDATE_COMPLETE_MESSAGE, *PUPDATE_COMPLETE_MESSAGE;
  289. //
  290. //  Message returned in Result parameter to GET_EVENT_MESSAGE api call.
  291. //  UpdateCompleteMessage   returned for UPDATE_COMPLETE message
  292. //  InterfaceIndex          returned for SAVE_INTERFACE_CONFIG_INFO message
  293. //
  294. typedef union _MESSAGE
  295. {
  296.     UPDATE_COMPLETE_MESSAGE UpdateCompleteMessage;
  297.     DWORD                   InterfaceIndex;
  298. }   MESSAGE, *PMESSAGE;
  299. //
  300. // Routing Interface Status types
  301. //
  302. #define RIS_INTERFACE_ADDRESS_CHANGE            0
  303. #define RIS_INTERFACE_ENABLED                   1
  304. #define RIS_INTERFACE_DISABLED                  2
  305. #define RIS_INTERFACE_MEDIA_PRESENT             3
  306. #define RIS_INTERFACE_MEDIA_ABSENT              4
  307. //
  308. // IPX Adapter Binding Info
  309. //
  310. typedef struct IPX_ADAPTER_BINDING_INFO
  311. {
  312.     ULONG AdapterIndex;
  313.     UCHAR Network[4];
  314.     UCHAR LocalNode[6];
  315.     UCHAR RemoteNode[6];
  316.     ULONG MaxPacketSize;
  317.     ULONG LinkSpeed;
  318. }IPX_ADAPTER_BINDING_INFO, *PIPX_ADAPTER_BINDING_INFO;
  319. //
  320. // IP Adapter Binding Info
  321. // This is the information associated with an ADDRESS_ARRIVAL event
  322. // An address arrival may have AddressCount == 0, this implies a unnumbered
  323. // interface
  324. //
  325. typedef struct IP_LOCAL_BINDING
  326. {
  327.     DWORD   Address;
  328.     DWORD   Mask;
  329. }IP_LOCAL_BINDING, *PIP_LOCAL_BINDING;
  330. typedef struct IP_ADAPTER_BINDING_INFO
  331. {
  332.     ULONG               AddressCount;
  333.     DWORD               RemoteAddress;
  334.     ULONG               Mtu;
  335.     ULONGLONG           Speed;
  336.     IP_LOCAL_BINDING    Address[0];
  337. }IP_ADAPTER_BINDING_INFO, *PIP_ADAPTER_BINDING_INFO;
  338. #define SIZEOF_IP_BINDING(X)                                
  339.     (FIELD_OFFSET(IP_ADAPTER_BINDING_INFO,Address[0]) +     
  340.      ((X) * sizeof(IP_LOCAL_BINDING)))
  341. typedef
  342. DWORD
  343. (WINAPI * PSTART_PROTOCOL) (
  344.     IN HANDLE              NotificationEvent,
  345.     IN PSUPPORT_FUNCTIONS   SupportFunctions,
  346.     IN LPVOID               GlobalInfo,
  347.     IN ULONG                StructureVersion,
  348.     IN ULONG                StructureSize,
  349.     IN ULONG                StructureCount
  350.     );
  351. typedef
  352. DWORD
  353. (WINAPI * PSTART_COMPLETE) (
  354.     VOID
  355.     );
  356. typedef
  357. DWORD
  358. (WINAPI * PSTOP_PROTOCOL) (
  359.     VOID
  360.     );
  361. typedef
  362. DWORD
  363. (WINAPI * PADD_INTERFACE) (
  364.     IN LPWSTR               InterfaceName,
  365.     IN ULONG             InterfaceIndex,
  366.     IN NET_INTERFACE_TYPE   InterfaceType,
  367.     IN DWORD                MediaType,
  368.     IN WORD                 AccessType,
  369.     IN WORD                 ConnectionType,
  370.     IN PVOID             InterfaceInfo,
  371.     IN ULONG                StructureVersion,
  372.     IN ULONG                StructureSize,
  373.     IN ULONG                StructureCount
  374.     );
  375. typedef
  376. DWORD
  377. (WINAPI * PDELETE_INTERFACE) (
  378.     IN ULONG InterfaceIndex
  379.     );
  380. typedef
  381. DWORD
  382. (WINAPI * PGET_EVENT_MESSAGE) (
  383.     OUT ROUTING_PROTOCOL_EVENTS  *Event,
  384.     OUT MESSAGE                  *Result
  385.     );
  386. typedef
  387. DWORD
  388. (WINAPI * PGET_INTERFACE_INFO) (
  389.     IN      ULONG InterfaceIndex,
  390.     IN      PVOID   InterfaceInfo,
  391.     IN  OUT PULONG  BufferSize,
  392.     OUT     PULONG StructureVersion,
  393.     IN      PULONG StructureSize,
  394.     OUT     PULONG StructureCount
  395.     );
  396. typedef
  397. DWORD
  398. (WINAPI * PSET_INTERFACE_INFO) (
  399.     IN ULONG InterfaceIndex,
  400.     IN PVOID InterfaceInfo,
  401.     IN ULONG    StructureVersion,
  402.     IN ULONG    StructureSize,
  403.     IN ULONG    StructureCount
  404.     );
  405. typedef
  406. DWORD
  407. (WINAPI * PINTERFACE_STATUS) (
  408.     IN ULONG InterfaceIndex,
  409.     IN BOOL     InterfaceActive,
  410.     IN DWORD    StatusType,
  411.     IN PVOID StatusInfo
  412.     );
  413. typedef
  414. DWORD
  415. (WINAPI * PQUERY_POWER) (
  416.     IN  DWORD   PowerType
  417.     );
  418. typedef
  419. DWORD
  420. (WINAPI * PSET_POWER) (
  421.     IN  DWORD   PowerType
  422.     );
  423. typedef
  424. DWORD
  425. (WINAPI * PGET_GLOBAL_INFO) (
  426.     IN     PVOID  GlobalInfo,
  427.     IN OUT PULONG   BufferSize,
  428.     OUT    PULONG StructureVersion,
  429.     OUT    PULONG   StructureSize,
  430.     OUT    PULONG   StructureCount
  431.     );
  432. typedef
  433. DWORD
  434. (WINAPI * PSET_GLOBAL_INFO) (
  435.     IN  PVOID  GlobalInfo,
  436.     IN  ULONG StructureVersion,
  437.     IN  ULONG   StructureSize,
  438.     IN  ULONG   StructureCount
  439.     );
  440. typedef
  441. DWORD
  442. (WINAPI * PDO_UPDATE_ROUTES) (
  443.     IN ULONG InterfaceIndex
  444.     );
  445. typedef
  446. DWORD
  447. (WINAPI * PMIB_CREATE) (
  448.     IN ULONG  InputDataSize,
  449.     IN PVOID  InputData
  450.     );
  451. typedef
  452. DWORD
  453. (WINAPI * PMIB_DELETE) (
  454.     IN ULONG  InputDataSize,
  455.     IN PVOID  InputData
  456.     );
  457. typedef
  458. DWORD
  459. (WINAPI * PMIB_GET) (
  460.     IN  ULONG InputDataSize,
  461.     IN  PVOID InputData,
  462.     OUT PULONG OutputDataSize,
  463.     OUT PVOID OutputData
  464.     );
  465. typedef
  466. DWORD
  467. (WINAPI * PMIB_SET) (
  468.     IN ULONG  InputDataSize,
  469.     IN PVOID InputData
  470.     );
  471. typedef
  472. DWORD
  473. (WINAPI * PMIB_GET_FIRST) (
  474.     IN  ULONG InputDataSize,
  475.     IN  PVOID InputData,
  476.     OUT PULONG  OutputDataSize,
  477.     OUT PVOID   OutputData
  478.     );
  479. typedef
  480. DWORD
  481. (WINAPI * PMIB_GET_NEXT) (
  482.     IN  ULONG   InputDataSize,
  483.     IN  PVOID InputData,
  484.     OUT PULONG  OutputDataSize,
  485.     OUT PVOID OutputData
  486.     );
  487. typedef
  488. DWORD
  489. (WINAPI * PMIB_SET_TRAP_INFO) (
  490.     IN  HANDLE  Event,
  491.     IN  ULONG   InputDataSize,
  492.     IN  PVOID InputData,
  493.     OUT PULONG OutputDataSize,
  494.     OUT PVOID OutputData
  495.     );
  496. typedef
  497. DWORD
  498. (WINAPI * PMIB_GET_TRAP_INFO) (
  499.     IN  ULONG InputDataSize,
  500.     IN  PVOID InputData,
  501.     OUT PULONG  OutputDataSize,
  502.     OUT PVOID OutputData
  503.     );
  504. typedef
  505. DWORD
  506. (WINAPI *PCONNECT_CLIENT) (
  507.     IN ULONG    InterfaceIndex,
  508.     IN PVOID    ClientAddress
  509.     );
  510. typedef
  511. DWORD
  512. (WINAPI *PDISCONNECT_CLIENT) (
  513.     IN ULONG    InterfaceIndex,
  514.     IN PVOID    ClientAddress
  515.     );
  516. //
  517. // InterfaceFlags used with the GetNeighbors() call below
  518. //
  519. #define MRINFO_TUNNEL_FLAG   0x01
  520. #define MRINFO_PIM_FLAG      0x04
  521. #define MRINFO_DOWN_FLAG     0x10
  522. #define MRINFO_DISABLED_FLAG 0x20
  523. #define MRINFO_QUERIER_FLAG  0x40
  524. #define MRINFO_LEAF_FLAG     0x80
  525. typedef
  526. DWORD
  527. (WINAPI *PGET_NEIGHBORS) (
  528.     IN     DWORD  InterfaceIndex,
  529.     IN     PDWORD NeighborList,
  530.     IN OUT PDWORD NeighborListSize,
  531.        OUT PBYTE  InterfaceFlags
  532.     );
  533. //
  534. // StatusCode values used with the GetMfeStatus() call below.
  535. // The protocol should return the highest-valued one that applies.
  536. //
  537. #define MFE_NO_ERROR          0 // none of the below events
  538. #define MFE_REACHED_CORE      1 // this router is an RP/core for the group
  539. //
  540. // StatusCode values set by oif owner only
  541. //
  542. #define MFE_OIF_PRUNED        5 // no downstream receivers exist on oif
  543. //
  544. // StatusCode values set by iif owner only
  545. //
  546. #define MFE_PRUNED_UPSTREAM   4 // a prune was send upstream
  547. #define MFE_OLD_ROUTER       11 // upstream nbr doesn't support mtrace
  548. //
  549. // StatusCode values which are used only by the Router Manager itself:
  550. //
  551. #define MFE_NOT_FORWARDING    2 // not fwding for an unspecified reason
  552. #define MFE_WRONG_IF          3 // mtrace received on iif
  553. #define MFE_BOUNDARY_REACHED  6 // iif or oif is admin scope boundary
  554. #define MFE_NO_MULTICAST      7 // oif is not multicast-enabled
  555. #define MFE_IIF               8 // mtrace arrived on iif
  556. #define MFE_NO_ROUTE          9 // router has no route that matches
  557. #define MFE_NOT_LAST_HOP     10 // router is not the proper last-hop router
  558. #define MFE_PROHIBITED       12 // mtrace is administratively prohibited
  559. #define MFE_NO_SPACE         13 // not enough room in packet
  560. typedef
  561. DWORD
  562. (WINAPI *PGET_MFE_STATUS) (
  563.     IN     DWORD  InterfaceIndex,
  564.     IN     DWORD  GroupAddress,
  565.     IN     DWORD  SourceAddress,
  566.     OUT    PBYTE  StatusCode
  567.     );
  568. //////////////////////////////////////////////////////////////////////////////
  569. //                                                                          //
  570. // This is the structure passed between the router manager and a protocol   //
  571. // upon registration.                                                       //
  572. //                                                                          //
  573. // IN OUT DWORD dwVersion                                                   //
  574. // This is filled by the router manager to indicate the version it supports.//
  575. // The DLL MUST set this to the version that the protocol will support.     //
  576. //                                                                          //
  577. // IN DWORD dwProtocolId                                                    //
  578. // This the protocol the router manager is expecting the DLL to register.   //
  579. // If the DLL does not support this protocol, it MUST return                //
  580. // ERROR_NOT_SUPPORTED                                                      //
  581. // A DLL will be called once for every protocol it supports                 //
  582. //                                                                          //
  583. // IN OUT DWORD fSupportedFunctionality                                     //
  584. // These are the flags denoting the functionality the router manager        //
  585. // supports. The DLL MUST reset this to the functionality that it supports. //
  586. //                                                                          //
  587. //////////////////////////////////////////////////////////////////////////////
  588. typedef struct _MPR50_ROUTING_CHARACTERISTICS
  589. {
  590.     DWORD               dwVersion;
  591.     DWORD               dwProtocolId;
  592.     DWORD               fSupportedFunctionality;
  593.     PSTART_PROTOCOL     pfnStartProtocol;
  594.     PSTART_COMPLETE     pfnStartComplete;
  595.     PSTOP_PROTOCOL      pfnStopProtocol;
  596.     PGET_GLOBAL_INFO    pfnGetGlobalInfo;
  597.     PSET_GLOBAL_INFO    pfnSetGlobalInfo;
  598.     PQUERY_POWER        pfnQueryPower;
  599.     PSET_POWER          pfnSetPower;
  600.     PADD_INTERFACE      pfnAddInterface;
  601.     PDELETE_INTERFACE   pfnDeleteInterface;
  602.     PINTERFACE_STATUS   pfnInterfaceStatus;
  603.     PGET_INTERFACE_INFO pfnGetInterfaceInfo;
  604.     PSET_INTERFACE_INFO pfnSetInterfaceInfo;
  605.     PGET_EVENT_MESSAGE  pfnGetEventMessage;
  606.     PDO_UPDATE_ROUTES   pfnUpdateRoutes;
  607.     PCONNECT_CLIENT     pfnConnectClient;
  608.     PDISCONNECT_CLIENT  pfnDisconnectClient;
  609.     PGET_NEIGHBORS      pfnGetNeighbors;
  610.     PGET_MFE_STATUS     pfnGetMfeStatus;
  611.     PMIB_CREATE         pfnMibCreateEntry;
  612.     PMIB_DELETE         pfnMibDeleteEntry;
  613.     PMIB_GET            pfnMibGetEntry;
  614.     PMIB_SET            pfnMibSetEntry;
  615.     PMIB_GET_FIRST      pfnMibGetFirstEntry;
  616.     PMIB_GET_NEXT       pfnMibGetNextEntry;
  617.     PMIB_SET_TRAP_INFO  pfnMibSetTrapInfo;
  618.     PMIB_GET_TRAP_INFO  pfnMibGetTrapInfo;
  619. }MPR50_ROUTING_CHARACTERISTICS;
  620. #if MPR50
  621. typedef MPR50_ROUTING_CHARACTERISTICS MPR_ROUTING_CHARACTERISTICS;
  622. #endif
  623. typedef MPR_ROUTING_CHARACTERISTICS *PMPR_ROUTING_CHARACTERISTICS;
  624. //
  625. // All routing protocols must export the following entry point.
  626. // The router manager calls this function to allow the routing
  627. // protocol to register
  628. //
  629. #define REGISTER_PROTOCOL_ENTRY_POINT           RegisterProtocol
  630. #define REGISTER_PROTOCOL_ENTRY_POINT_STRING    "RegisterProtocol"
  631. typedef
  632. DWORD
  633. (WINAPI * PREGISTER_PROTOCOL) (
  634.     IN OUT PMPR_ROUTING_CHARACTERISTICS pRoutingChar,
  635.     IN OUT PMPR_SERVICE_CHARACTERISTICS pServiceChar
  636.     );
  637. #ifdef __cplusplus
  638. }
  639. #endif
  640. #if _MSC_VER >= 1200
  641. #pragma warning(pop)
  642. #else
  643. #pragma warning(default:4200)
  644. #pragma warning(default:4201)
  645. #endif
  646. #endif      // _ROUTPROT_H_