class XrlRouter XRL transmission and reception point. More... Definition #include <xrlrouter.hh> Inherits XrlCmdMap [public ] Inherited by XrlStdRouter List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• typedef XorpCallback4<void, const XrlError&, XrlRouter&, const Xrl&, XrlArgs*>::RefPtr XrlCallback

Public Methods

•  XrlRouter (EventLoop& event_loop, const char* entity_name)
•  XrlRouter (EventLoop& event_loop, const char* entity_name, const char* finder_address)
•  XrlRouter (EventLoop& event_loop, const char* entity_name, const char* finder_address, uint16_t finder_port)
• virtual  ~XrlRouter ()
• bool  add_listener (XrlPFListener* pf)
• bool  send (const Xrl& xrl, const XrlCallback& callback)
• inline bool  send (const Xrl& xrl, ResponseCallback user_callback, void* cookie = 0)
• bool  pending () const
• XrlRouter&  operator= (const XrlRouter&)
•  XrlRouter (const XrlRouter&)
• inline bool  connected () const

Public Members

• typedef void  (*ResponseCallback) (const XrlError& e, XrlRouter& router, const Xrl& request, XrlArgs* response, void* cookie)

Detailed Description

An XrlRouter is responsible for sending and receiving XRL requests for entities in a XORP Router. A single process may have multiple XrlRouter objects. In this case each XrlRouter object corresponds to an independent entity within the process.

Constructor for when the Finder is running on the local host.

Parameters:

event_loop	the EventLoop that the XrlRouter should associate itself with.
entity_name	the name this router will register with the Finder.

Constructor for when the Finder is running on another host on the default Finder port.

Parameters:

event_loop	the EventLoop that the XrlRouter should associate itself with.
entity_name	the name this router will register with the Finder.
finder_address	the hostname running the Finder process.

Constructor for when the Finder is running on another host on and listening on a custom port.

Parameters:

event_loop	the EventLoop that the XrlRouter should associate itself with.
entity_name	the name this router will register with the Finder.
finder_address	the hostname running the Finder process.
finder_port	the port the Finder process is listening on.

[virtual]

Add a protocol family listener.

This call associates the entity name of the XrlRouter with the protocol family listener at the Finder. Other processes may then contact this XrlRouter through the Listener by resolving the entity name.

Registration may fail if the entity name of the XrlRouter object is already in use at the Finder, or if the Finder is not contactable.

Returns: true if registration succeeds, false otherwise.

Dispatch an Xrl.

NB A callback must be supplied if the Xrl returns a value. If the Xrl returns nothing, a callback is only necessary if the dispatcher wants to know that the Xrl dispatch was successful and completed.

Parameters:

xrl	The Xrl to be dispatched.
callback	invoked when the Xrl has returns or fails.

Returns: true if sufficient resources available, false otherwise.

[Deprecated] Dispatch an Xrl.

NB A callback must be supplied if the Xrl returns a value. If the Xrl returns nothing, a callback is only necessary if the dispatcher wants to know that the Xrl dispatch was successful and completed.

Parameters:

xrl	The Xrl to be dispatched.
user_callback	invoked when the Xrl has returns or fails.
cookie	to be passed to the user_callback.

Returns: true if sufficient resources available, false otherwise.

[const]

Returns true if this router has any pending actions.

Assignment operator (unimplemented and compiler generated not wanted).

Copy constructor (unimplemented and compiler generated not wanted).

[const]

Check if XrlRouter has connection to finder, ie is operational.

Returns: true if connected to finder, false if attempting to connect to finder.