|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlTestPeerTargetBase (XrlCmdMap* cmds = 0)
| XrlTestPeerTargetBase |
Constructor.
Parameters:
| cmds | an 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.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer 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.
| inline const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| inline const char* version ()
| version |
[const]
Get version string of instance.
| XrlCmdError common_0_1_get_target_name (
string& name)
| common_0_1_get_target_name |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_get_version (
string& version)
| common_0_1_get_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get version string from Xrl Target
| XrlCmdError common_0_1_get_status (
uint32_t& status,
string& reason)
| common_0_1_get_status |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_shutdown ()
| common_0_1_shutdown |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Request clean shutdown of Xrl Target
| XrlCmdError test_peer_0_1_register (
const string& coordinator,
const uint32_t& genid)
| test_peer_0_1_register |
[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:
| genid | Generation id. |
| XrlCmdError test_peer_0_1_packetisation (
const string& protocol)
| test_peer_0_1_packetisation |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError test_peer_0_1_connect (
const string& host,
const uint32_t& port)
| test_peer_0_1_connect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Make a tcp connection to the specified host and port.
Parameters:
| host | name. |
| port | number. |
| XrlCmdError test_peer_0_1_listen (
const string& address,
const uint32_t& port)
| test_peer_0_1_listen |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Listen for connections on this address and port.
Parameters:
| address | local address. |
| port | local port number. |
| XrlCmdError test_peer_0_1_bind (
const string& address,
const uint32_t& port)
| test_peer_0_1_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Bind the port but don't perform the listen or accept.
Parameters:
| address | local address. |
| port | local port number. |
| XrlCmdError test_peer_0_1_send (
const vector<uint8_t>& data)
| test_peer_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data Send data to the peer.
| XrlCmdError test_peer_0_1_disconnect ()
| test_peer_0_1_disconnect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError test_peer_0_1_reset ()
| 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.
| XrlCmdError test_peer_0_1_terminate ()
| test_peer_0_1_terminate |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Terminate the test peer process.
