xorp

XrlTestPeerTargetBase Class Reference

Inheritance diagram for XrlTestPeerTargetBase:
XrlTestPeerTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlTestPeerTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlTestPeerTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlTestPeerTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlTestPeerTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_register (const string &coordinator, const uint32_t &genid)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_packetisation (const string &protocol)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_use_4byte_asnums (const bool &use)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_connect (const string &host, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_listen (const string &address, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_bind (const string &address, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_send (const vector< uint8_t > &data)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_disconnect ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_reset ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_terminate ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_register (const string &coordinator, const uint32_t &genid)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_packetisation (const string &protocol)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_use_4byte_asnums (const bool &use)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_connect (const string &host, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_listen (const string &address, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_bind (const string &address, const uint32_t &port)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_send (const vector< uint8_t > &data)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_disconnect ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_reset ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError test_peer_0_1_terminate ()=0
 Pure-virtual function that needs to be implemented to:

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_register (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_packetisation (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_use_4byte_asnums (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_connect (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_listen (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_bind (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_send (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_disconnect (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_reset (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_terminate (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_register (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_packetisation (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_use_4byte_asnums (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_connect (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_listen (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_bind (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_send (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_disconnect (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_reset (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_test_peer_0_1_terminate (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlTestPeerTargetBase::handlers) / sizeof(XrlTestPeerTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlTestPeerTargetBase::XrlTestPeerTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
XrlTestPeerTargetBase::~XrlTestPeerTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlTestPeerTargetBase::XrlTestPeerTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
virtual XrlTestPeerTargetBase::~XrlTestPeerTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlTestPeerTarget.

bool XrlTestPeerTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.
bool XrlTestPeerTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.
virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_bind ( const string &  address,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Bind the port but don't perform the listen or accept.

Parameters:
addresslocal address.
portlocal port number.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_bind ( const string &  address,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Bind the port but don't perform the listen or accept.

Parameters:
addresslocal address.
portlocal port number.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_connect ( const string &  host,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Make a tcp connection to the specified host and port.

Parameters:
hostname.
portnumber.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_connect ( const string &  host,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Make a tcp connection to the specified host and port.

Parameters:
hostname.
portnumber.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_disconnect ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disconnect from the peer.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_disconnect ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disconnect from the peer.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_listen ( const string &  address,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Listen for connections on this address and port.

Parameters:
addresslocal address.
portlocal port number.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_listen ( const string &  address,
const uint32_t &  port 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Listen for connections on this address and port.

Parameters:
addresslocal address.
portlocal port number.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_packetisation ( const string &  protocol) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Packetisation style.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_packetisation ( const string &  protocol) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Packetisation style.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_register ( const string &  coordinator,
const uint32_t &  genid 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register for receiving packets and events. The registering process must implement the "datain" interface in order to receive data.

Parameters:
genidGeneration id.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_register ( const string &  coordinator,
const uint32_t &  genid 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register for receiving packets and events. The registering process must implement the "datain" interface in order to receive data.

Parameters:
genidGeneration id.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_reset ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the peer. Take it back to a known state.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_reset ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the peer. Take it back to a known state.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_send ( const vector< uint8_t > &  data) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Send data Send data to the peer.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_send ( const vector< uint8_t > &  data) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Send data Send data to the peer.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_terminate ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Terminate the test peer process.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_terminate ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Terminate the test peer process.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_use_4byte_asnums ( const bool &  use) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set whether to assume 2 or 4 byte AS numbers when decoding.

Implemented in XrlTestPeerTarget.

virtual XrlCmdError XrlTestPeerTargetBase::test_peer_0_1_use_4byte_asnums ( const bool &  use) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set whether to assume 2 or 4 byte AS numbers when decoding.

Implemented in XrlTestPeerTarget.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations