Auto-generated base for TcpClient component. More...

#include <Drv/TcpClient/TcpClientComponentAc.hpp>

Inheritance diagram for Drv::TcpClientComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize TcpClientComponentBase object. More...

Fw::InputBufferSendPort *	get_send_InputPort (FwIndexType portNum)

void	set_allocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
	Connect port to allocate[portNum]. More...

void	set_dataReturnOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamDataPort *port)
	Connect port to dataReturnOut[portNum]. More...

void	set_ready_OutputPort (FwIndexType portNum, Drv::InputByteStreamReadyPort *port)
	Connect port to ready[portNum]. More...

void	set_recv_OutputPort (FwIndexType portNum, Drv::InputByteStreamDataPort *port)
	Connect port to recv[portNum]. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...

U32	getIdBase () const

Protected Types
enum	{ NUM_SEND_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_ALLOCATE_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1, NUM_READY_OUTPUT_PORTS = 1, NUM_RECV_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

Protected Member Functions
	TcpClientComponentBase (const char *compName="")
	Construct TcpClientComponentBase object. More...

virtual	~TcpClientComponentBase ()
	Destroy TcpClientComponentBase object. More...

FwIndexType	getNum_send_InputPorts () const

FwIndexType	getNum_allocate_OutputPorts () const

FwIndexType	getNum_dataReturnOut_OutputPorts () const

FwIndexType	getNum_ready_OutputPorts () const

FwIndexType	getNum_recv_OutputPorts () const

bool	isConnected_allocate_OutputPort (FwIndexType portNum)

bool	isConnected_dataReturnOut_OutputPort (FwIndexType portNum)

bool	isConnected_ready_OutputPort (FwIndexType portNum)

bool	isConnected_recv_OutputPort (FwIndexType portNum)

virtual void	send_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
	Handler for input port send. More...

void	send_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Handler base-class function for input port send. More...

Fw::Buffer	allocate_out (FwIndexType portNum, U32 size)
	Invoke output port allocate. More...

void	dataReturnOut_out (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
	Invoke output port dataReturnOut. More...

void	ready_out (FwIndexType portNum)
	Invoke output port ready. More...

void	recv_out (FwIndexType portNum, Fw::Buffer &buffer, const Drv::ByteStreamStatus &status)
	Invoke output port recv. More...

virtual void	lock ()
	Lock the guarded mutex. More...

virtual void	unLock ()
	Unlock the guarded mutex. More...

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	Initialization function. More...

FwEnumStoreType	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Friends
class	TcpClientComponentBaseFriend
	Friend class for white-box testing. More...

class	TcpClientTesterBase
	Friend class tester to support autocoded test harness. More...

Detailed Description

Auto-generated base for TcpClient component.

Definition at line 24 of file TcpClientComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_SEND_INPUT_PORTS

Definition at line 44 of file TcpClientComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS
NUM_DATARETURNOUT_OUTPUT_PORTS
NUM_READY_OUTPUT_PORTS
NUM_RECV_OUTPUT_PORTS

Definition at line 49 of file TcpClientComponentAc.hpp.

Constructor & Destructor Documentation

◆ TcpClientComponentBase()

Drv::TcpClientComponentBase::TcpClientComponentBase ( const char * compName = "" )

protected

Construct TcpClientComponentBase object.

Parameters

compName The component name

Definition at line 257 of file TcpClientComponentAc.cpp.

◆ ~TcpClientComponentBase()

Drv::TcpClientComponentBase::~TcpClientComponentBase ( )

protectedvirtual

Destroy TcpClientComponentBase object.

Definition at line 264 of file TcpClientComponentAc.cpp.

Member Function Documentation

◆ allocate_out()

Fw::Buffer Drv::TcpClientComponentBase::allocate_out	(	FwIndexType	portNum,
		U32	size
	)

protected

Invoke output port allocate.

Parameters

portNum	The port number
size	The requested size

Definition at line 391 of file TcpClientComponentAc.cpp.

◆ dataReturnOut_out()

void Drv::TcpClientComponentBase::dataReturnOut_out	(	FwIndexType	portNum,
		Fw::Buffer &	buffer,
		const Drv::ByteStreamStatus &	status
	)

protected

Invoke output port dataReturnOut.

Parameters

portNum The port number

Definition at line 411 of file TcpClientComponentAc.cpp.

◆ get_send_InputPort()

Fw::InputBufferSendPort * Drv::TcpClientComponentBase::get_send_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: send[portNum]

Parameters

portNum The port number

Definition at line 132 of file TcpClientComponentAc.cpp.

◆ getNum_allocate_OutputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_allocate_OutputPorts ( ) const

protected

Get the number of allocate output ports

Returns: The number of allocate output ports

Definition at line 284 of file TcpClientComponentAc.cpp.

◆ getNum_dataReturnOut_OutputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_dataReturnOut_OutputPorts ( ) const

protected

Get the number of dataReturnOut output ports

Returns: The number of dataReturnOut output ports

Definition at line 290 of file TcpClientComponentAc.cpp.

◆ getNum_ready_OutputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_ready_OutputPorts ( ) const

protected

Get the number of ready output ports

Returns: The number of ready output ports

Definition at line 296 of file TcpClientComponentAc.cpp.

◆ getNum_recv_OutputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_recv_OutputPorts ( ) const

protected

Get the number of recv output ports

Returns: The number of recv output ports

Definition at line 302 of file TcpClientComponentAc.cpp.

◆ getNum_send_InputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_send_InputPorts ( ) const

protected

Get the number of send input ports

Returns: The number of send input ports

Definition at line 274 of file TcpClientComponentAc.cpp.

◆ init()

void Drv::TcpClientComponentBase::init ( FwEnumStoreType instance = 0 )

Initialize TcpClientComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file TcpClientComponentAc.cpp.

◆ isConnected_allocate_OutputPort()

bool Drv::TcpClientComponentBase::isConnected_allocate_OutputPort ( FwIndexType portNum )

protected

Check whether port allocate is connected

Returns: Whether port allocate is connected

Parameters

portNum The port number

Definition at line 312 of file TcpClientComponentAc.cpp.

◆ isConnected_dataReturnOut_OutputPort()

bool Drv::TcpClientComponentBase::isConnected_dataReturnOut_OutputPort ( FwIndexType portNum )

protected

Check whether port dataReturnOut is connected

Returns: Whether port dataReturnOut is connected

Parameters

portNum The port number

Definition at line 323 of file TcpClientComponentAc.cpp.

◆ isConnected_ready_OutputPort()

bool Drv::TcpClientComponentBase::isConnected_ready_OutputPort ( FwIndexType portNum )

protected

Check whether port ready is connected

Returns: Whether port ready is connected

Parameters

portNum The port number

Definition at line 334 of file TcpClientComponentAc.cpp.

◆ isConnected_recv_OutputPort()

bool Drv::TcpClientComponentBase::isConnected_recv_OutputPort ( FwIndexType portNum )

protected

Check whether port recv is connected

Returns: Whether port recv is connected

Parameters

portNum The port number

Definition at line 345 of file TcpClientComponentAc.cpp.

◆ lock()

void Drv::TcpClientComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 477 of file TcpClientComponentAc.cpp.

◆ ready_out()

void Drv::TcpClientComponentBase::ready_out ( FwIndexType portNum )

protected

Invoke output port ready.

Parameters

portNum The port number

Definition at line 433 of file TcpClientComponentAc.cpp.

◆ recv_out()

void Drv::TcpClientComponentBase::recv_out	(	FwIndexType	portNum,
		Fw::Buffer &	buffer,
		const Drv::ByteStreamStatus &	status
	)

protected

Invoke output port recv.

Parameters

portNum The port number

Definition at line 448 of file TcpClientComponentAc.cpp.

◆ send_handler()

virtual void Drv::TcpClientComponentBase::send_handler	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protectedpure virtual

Handler for input port send.

Parameters

portNum	The port number
fwBuffer	The buffer

◆ send_handlerBase()

void Drv::TcpClientComponentBase::send_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	fwBuffer
	)

protected

Handler base-class function for input port send.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 362 of file TcpClientComponentAc.cpp.

◆ set_allocate_OutputPort()

void Drv::TcpClientComponentBase::set_allocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferGetPort *	port
	)

Connect port to allocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 147 of file TcpClientComponentAc.cpp.

◆ set_dataReturnOut_OutputPort()

void Drv::TcpClientComponentBase::set_dataReturnOut_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamDataPort *	port
	)

Connect port to dataReturnOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 161 of file TcpClientComponentAc.cpp.

◆ set_ready_OutputPort()

void Drv::TcpClientComponentBase::set_ready_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamReadyPort *	port
	)

Connect port to ready[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 175 of file TcpClientComponentAc.cpp.

◆ set_recv_OutputPort()

void Drv::TcpClientComponentBase::set_recv_OutputPort	(	FwIndexType	portNum,
		Drv::InputByteStreamDataPort *	port
	)

Connect port to recv[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 189 of file TcpClientComponentAc.cpp.

◆ unLock()

void Drv::TcpClientComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 483 of file TcpClientComponentAc.cpp.

Friends And Related Function Documentation

◆ TcpClientComponentBaseFriend

friend class TcpClientComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 33 of file TcpClientComponentAc.hpp.

◆ TcpClientTesterBase

friend class TcpClientTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 35 of file TcpClientComponentAc.hpp.

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

Drv/TcpClient/TcpClientComponentAc.hpp
Drv/TcpClient/TcpClientComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ TcpClientComponentBase()

◆ ~TcpClientComponentBase()

Member Function Documentation

◆ allocate_out()

◆ dataReturnOut_out()

◆ get_send_InputPort()

◆ getNum_allocate_OutputPorts()

◆ getNum_dataReturnOut_OutputPorts()

◆ getNum_ready_OutputPorts()

◆ getNum_recv_OutputPorts()

◆ getNum_send_InputPorts()

◆ init()

◆ isConnected_allocate_OutputPort()

◆ isConnected_dataReturnOut_OutputPort()

◆ isConnected_ready_OutputPort()

◆ isConnected_recv_OutputPort()

◆ lock()

◆ ready_out()

◆ recv_out()

◆ send_handler()

◆ send_handlerBase()

◆ set_allocate_OutputPort()

◆ set_dataReturnOut_OutputPort()

◆ set_ready_OutputPort()

◆ set_recv_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ TcpClientComponentBaseFriend

◆ TcpClientTesterBase