_ENTITY_METHOD callback function (rtmv2.h)

The RTM_ENTITY_EXPORT_METHOD callback is the prototype for any method exported by a client.

Syntax

_ENTITY_METHOD EntityMethod;

void EntityMethod(
  RTM_ENTITY_HANDLE CallerHandle,
  RTM_ENTITY_HANDLE CalleeHandle,
  RTM_ENTITY_METHOD_INPUT *Input,
  RTM_ENTITY_METHOD_OUTPUT *Output
)
{...}

Parameters

CallerHandle

Handle to the calling client.

CalleeHandle

Handle to the client being called.

Input

Handle to the method to be invoked. Contains an input buffer.

Output

An array of RTM_ENTITY_METHOD_OUTPUT structures. Each structure consists of a (method identifier, correct output) tuple.

Return value

None

Remarks

Methods can be exported when a client registers. Other clients, such as routing protocols, can invoke these methods to obtain client-specific information. For example, BGP can use a method to obtain OSFP information.

Requirements

See also

RTM_ENTITY_METHOD_INPUT

RTM_ENTITY_METHOD_OUTPUT