Classes
struct	handler_table
Public Member Functions
	XrlTestSocket6TargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlTestSocket6TargetBase ()
	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.
	XrlTestSocket6TargetBase (XrlCmdMap *cmds=0)
	Constructor.
virtual	~XrlTestSocket6TargetBase ()
	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	socket6_user_0_1_recv_event (const string &sockid, const string &if_name, const string &vif_name, const IPv6 &src_host, const uint32_t &src_port, const vector< uint8_t > &data)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_inbound_connect_event (const string &sockid, const IPv6 &src_host, const uint32_t &src_port, const string &new_sockid, bool &accept)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_outgoing_connect_event (const string &sockid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_error_event (const string &sockid, const string &error, const bool &fatal)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_disconnect_event (const string &sockid)=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	socket6_user_0_1_recv_event (const string &sockid, const string &if_name, const string &vif_name, const IPv6 &src_host, const uint32_t &src_port, const vector< uint8_t > &data)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_inbound_connect_event (const string &sockid, const IPv6 &src_host, const uint32_t &src_port, const string &new_sockid, bool &accept)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_outgoing_connect_event (const string &sockid)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_error_event (const string &sockid, const string &error, const bool &fatal)=0
	Pure-virtual function that needs to be implemented to:
virtual XrlCmdError	socket6_user_0_1_disconnect_event (const string &sockid)=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_socket6_user_0_1_recv_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_inbound_connect_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_outgoing_connect_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_error_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_disconnect_event (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_socket6_user_0_1_recv_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_inbound_connect_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_outgoing_connect_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_error_event (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT	handle_socket6_user_0_1_disconnect_event (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(XrlTestSocket6TargetBase::handlers) / sizeof(XrlTestSocket6TargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlTestSocket6TargetBase::XrlTestSocket6TargetBase ( XrlCmdMap * cmds = 0 )

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.

XrlTestSocket6TargetBase::~XrlTestSocket6TargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlTestSocket6TargetBase::XrlTestSocket6TargetBase ( XrlCmdMap * cmds = 0 )

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.

virtual XrlTestSocket6TargetBase::~XrlTestSocket6TargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

Member Function Documentation

virtual XrlCmdError XrlTestSocket6TargetBase::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

virtual XrlCmdError XrlTestSocket6TargetBase::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

virtual XrlCmdError XrlTestSocket6TargetBase::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

virtual XrlCmdError XrlTestSocket6TargetBase::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

virtual XrlCmdError XrlTestSocket6TargetBase::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

virtual XrlCmdError XrlTestSocket6TargetBase::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

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

bool XrlTestSocket6TargetBase::set_command_map ( XrlCmdMap * cmds )

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.

bool XrlTestSocket6TargetBase::set_command_map ( XrlCmdMap * cmds )

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.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_disconnect_event ( const string & sockid ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when the peer has closed the connection. It applies only to TCP sockets. Note that the socket itself is left open and must be explicitly closed.

Parameters:

sockid the identifier associated with socket where the event occurred.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_disconnect_event ( const string & sockid ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when the peer has closed the connection. It applies only to TCP sockets. Note that the socket itself is left open and must be explicitly closed.

Parameters:

sockid the identifier associated with socket where the event occurred.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_error_event	(	const string &	sockid,
		const string &	error,
		const bool &	fatal
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when an error occurs.

Parameters:

sockid	the identifier associated with socket where the event occurred.
error	a textual description of the error.
fatal	indication of whether socket is shutdown because of error.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_error_event	(	const string &	sockid,
		const string &	error,
		const bool &	fatal
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when an error occurs.

Parameters:

sockid	the identifier associated with socket where the event occurred.
error	a textual description of the error.
fatal	indication of whether socket is shutdown because of error.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_inbound_connect_event	(	const string &	sockid,
		const IPv6 &	src_host,
		const uint32_t &	src_port,
		const string &	new_sockid,
		bool &	accept
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when a connection request is received from an IPv6 source. It applies only to TCP sockets.

Parameters:

sockid	the identifier associated with socket where the event occurred.
src_host	the connecting host.
src_port	the connecting IP port.
new_sockid	the identifier associated with the new socket that has been created to handle the new connection.
accept	if true, the connection request has been accepted, otherwise it has been rejected.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_inbound_connect_event	(	const string &	sockid,
		const IPv6 &	src_host,
		const uint32_t &	src_port,
		const string &	new_sockid,
		bool &	accept
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when a connection request is received from an IPv6 source. It applies only to TCP sockets.

Parameters:

sockid	the identifier associated with socket where the event occurred.
src_host	the connecting host.
src_port	the connecting IP port.
new_sockid	the identifier associated with the new socket that has been created to handle the new connection.
accept	if true, the connection request has been accepted, otherwise it has been rejected.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_outgoing_connect_event ( const string & sockid ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when an outgoing connection request originated by the local host is completed. It applies only to TCP sockets. Note that if the connection failed, the error_event will be dispatched instead.

Parameters:

sockid the identifier associated with socket where the event occurred.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_outgoing_connect_event ( const string & sockid ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when an outgoing connection request originated by the local host is completed. It applies only to TCP sockets. Note that if the connection failed, the error_event will be dispatched instead.

Parameters:

sockid the identifier associated with socket where the event occurred.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_recv_event	(	const string &	sockid,
		const string &	if_name,
		const string &	vif_name,
		const IPv6 &	src_host,
		const uint32_t &	src_port,
		const vector< uint8_t > &	data
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when a packet arrives from an IPv6 source.

Parameters:

sockid	the identifier associated with socket where the event occurred.
if_name	the interface name the packet arrived on, if known. If unknown, then it is an empty string.
vif_name	the vif name the packet arrived on, if known. If unknown, then it is an empty string.
src_host	the originating host.
src_port	the originating IP port.
data	the data received.

virtual XrlCmdError XrlTestSocket6TargetBase::socket6_user_0_1_recv_event	(	const string &	sockid,
		const string &	if_name,
		const string &	vif_name,
		const IPv6 &	src_host,
		const uint32_t &	src_port,
		const vector< uint8_t > &	data
	)		`[protected, pure virtual]`

Pure-virtual function that needs to be implemented to:

Method invoked by target implementing socket6/0.1 when a packet arrives from an IPv6 source.

Parameters:

sockid	the identifier associated with socket where the event occurred.
if_name	the interface name the packet arrived on, if known. If unknown, then it is an empty string.
vif_name	the vif name the packet arrived on, if known. If unknown, then it is an empty string.
src_host	the originating host.
src_port	the originating IP port.
data	the data received.

The documentation for this class was generated from the following files:

/home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/test_socket6_base.cc
/home/greearb/git/xorp.ct.github/xorp/obj/i386-pc-mingw32/xrl/targets/test_socket6_base.hh
/home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/test_socket6_base.hh
/home/greearb/git/xorp.ct.github/xorp/obj/i686-pc-linux-gnu/xrl/targets/test_socket6_base.cc

XrlTestSocket6TargetBase Class Reference

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Constructor & Destructor Documentation

Member Function Documentation