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