Edit

MPR60_ROUTING_CHARACTERISTICS structure (routprot.h)

  • Article

The MPR_ROUTING_CHARACTERISTICS structure contains information used to register routing protocols with the router manager.

Syntax

typedef struct _MPR60_ROUTING_CHARACTERISTICS {
  DWORD                           dwVersion;
  DWORD                           dwProtocolId;
  DWORD                           fSupportedFunctionality;
  PSTART_PROTOCOL                 pfnStartProtocol;
  PSTART_COMPLETE                 pfnStartComplete;
  PSTOP_PROTOCOL                  pfnStopProtocol;
  PGET_GLOBAL_INFO                pfnGetGlobalInfo;
  PSET_GLOBAL_INFO                pfnSetGlobalInfo;
  PQUERY_POWER                    pfnQueryPower;
  PSET_POWER                      pfnSetPower;
  PADD_INTERFACE                  pfnAddInterface;
  PDELETE_INTERFACE               pfnDeleteInterface;
  PINTERFACE_STATUS               pfnInterfaceStatus;
  PGET_INTERFACE_INFO             pfnGetInterfaceInfo;
  PSET_INTERFACE_INFO             pfnSetInterfaceInfo;
  PGET_EVENT_MESSAGE              pfnGetEventMessage;
  PDO_UPDATE_ROUTES               pfnUpdateRoutes;
  PCONNECT_CLIENT                 pfnConnectClient;
  PDISCONNECT_CLIENT              pfnDisconnectClient;
  PGET_NEIGHBORS                  pfnGetNeighbors;
  PGET_MFE_STATUS                 pfnGetMfeStatus;
  PMIB_CREATE                     pfnMibCreateEntry;
  PMIB_DELETE                     pfnMibDeleteEntry;
  PMIB_GET                        pfnMibGetEntry;
  PMIB_SET                        pfnMibSetEntry;
  PMIB_GET_FIRST                  pfnMibGetFirstEntry;
  PMIB_GET_NEXT                   pfnMibGetNextEntry;
  PMIB_SET_TRAP_INFO              pfnMibSetTrapInfo;
  PMIB_GET_TRAP_INFO              pfnMibGetTrapInfo;
  PPROTOCOL_ACTION                pfnProtocolAction;
  PGET_PROTOCOL_STATISTICS        pfnGetStatistics;
  PGET_ROUTING_DOMAIN_GLOBAL_INFO pfnGetRoutingDomainGlobalInfo;
  PSET_ROUTING_DOMAIN_GLOBAL_INFO pfnSetRoutingDomainGlobalInfo;
  PPROTOCOL_BUFFER_FREE           pfnBufferFree;
} MPR60_ROUTING_CHARACTERISTICS;

Members

dwVersion

On input, specifies the version of RRAS currently running.

On output, the routing protocol should specify the version of RRAS that it requires.

The symbol MS_ROUTER_VERSION in the header file Routprot.h is defined to be the RRAS version for a given implementation.

dwProtocolId

Specifies the routing protocol that the router manager requests the DLL to register. (A common name space is used for all protocol families.)

fSupportedFunctionality

On input, specifies the functionality that the router manager supports.

On output, the routing protocol should reset these flags to indicate the subset of functionality that it supports.

This parameter is a combination of one or more of the following values.

Value Meaning
ROUTING
 The protocol participates in multi-protocol routing by importing routing table manager APIs. There is one routing table manager that maintains a table for each protocol family (such as IP and IPX).
SERVICES
 The protocol assumes responsibility for managing services (such as IPX SAP), and provides Service Table Management APIs.
DEMAND_UPDATE_ROUTES
 The protocol is able to perform autostatic updates of routes when requested by the router manager.
DEMAND_UPDATE_SERVICES
 The protocol is able to perform autostatic updates of services when requested by the router manager.

pfnStartProtocol

Pointer to an implementation of the StartProtocol function for this routing protocol.

pfnStartComplete

Pointer to an implementation of the StartComplete function for this routing protocol.

pfnStopProtocol

Pointer to an implementation of the StopProtocol function for this routing protocol.

pfnGetGlobalInfo

Pointer to an implementation of the GetGlobalInfo function for this routing protocol.

pfnSetGlobalInfo

Pointer to an implementation of the SetGlobalInfo function for this routing protocol.

pfnQueryPower

Pointer to an implementation of the QueryPower function for this routing protocol.

pfnSetPower

Pointer to an implementation of the SetPower function for this routing protocol.

pfnAddInterface

Pointer to an implementation of the AddInterface function for this routing protocol.

pfnDeleteInterface

Pointer to an implementation of the DeleteInterface function for this routing protocol.

pfnInterfaceStatus

Pointer to an implementation of the InterfaceStatus function for this routing protocol.

pfnGetInterfaceInfo

Pointer to an implementation of the GetInterfaceInfo function for this routing protocol.

pfnSetInterfaceInfo

Pointer to an implementation of the SetInterfaceInfo function for this routing protocol.

pfnGetEventMessage

Pointer to an implementation of the GetEventMessage function for this routing protocol.

pfnUpdateRoutes

Pointer to an implementation of the DoUpdateRoutes function for this routing protocol.

pfnConnectClient

Pointer to an implementation of the ConnectClient function for this routing protocol.

pfnDisconnectClient

Pointer to an implementation of the DisconnectClient function for this routing protocol.

pfnGetNeighbors

Pointer to an implementation of the GetNeighbors function for this routing protocol.

pfnGetMfeStatus

Pointer to an implementation of the GetMfeStatus function for this routing protocol.

pfnMibCreateEntry

Pointer to an implementation of the MibCreate function for this routing protocol.

pfnMibDeleteEntry

Pointer to an implementation of the MibDelete function for this routing protocol.

pfnMibGetEntry

Pointer to an implementation of the MibGet function for this routing protocol.

pfnMibSetEntry

Pointer to an implementation of the MibSet function for this routing protocol.

pfnMibGetFirstEntry

Pointer to an implementation of the MibGetFirst function for this routing protocol.

pfnMibGetNextEntry

Pointer to an implementation of the MibGetNext function for this routing protocol.

pfnMibSetTrapInfo

Pointer to an implementation of the MibSetTrapInfo function for this routing protocol.

pfnMibGetTrapInfo

Pointer to an implementation of the MibGetTrapInfo function for this routing protocol.

pfnProtocolAction

pfnGetStatistics

pfnGetRoutingDomainGlobalInfo

pfnSetRoutingDomainGlobalInfo

pfnBufferFree

Remarks

Most of the members of this structure are pointers to functions implemented in the routing protocol DLL. The routing protocol fills in the address values for these pointers during a call to the RegisterProtocol function.

For a complete description of a particular function pointed to by one of the structure members, see the reference page for that function.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Header routprot.h

See also

Protocol Identifiers

RegisterProtocol

Routing Protocol Interface Reference

Routing Protocol Interface Structures