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...

Drv::InputByteStreamSendPort *	get_send_InputPort (FwIndexType portNum)

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

void	set_deallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
	Connect port to deallocate[portNum]. More...

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

void	set_recv_OutputPort (FwIndexType portNum, Drv::InputByteStreamRecvPort *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_DEALLOCATE_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_deallocate_OutputPorts () const

FwIndexType	getNum_ready_OutputPorts () const

FwIndexType	getNum_recv_OutputPorts () const

bool	isConnected_allocate_OutputPort (FwIndexType portNum)

bool	isConnected_deallocate_OutputPort (FwIndexType portNum)

bool	isConnected_ready_OutputPort (FwIndexType portNum)

bool	isConnected_recv_OutputPort (FwIndexType portNum)

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

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

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

void	deallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
	Invoke output port deallocate. More...

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

void	recv_out (FwIndexType portNum, Fw::Buffer &recvBuffer, const Drv::RecvStatus &recvStatus)
	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 (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	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...

Detailed Description

Auto-generated base for TcpClient component.

Definition at line 25 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 43 of file TcpClientComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_ALLOCATE_OUTPUT_PORTS
NUM_DEALLOCATE_OUTPUT_PORTS
NUM_READY_OUTPUT_PORTS
NUM_RECV_OUTPUT_PORTS

Definition at line 48 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 256 of file TcpClientComponentAc.cpp.

◆ ~TcpClientComponentBase()

Drv::TcpClientComponentBase::~TcpClientComponentBase ( )

protectedvirtual

Destroy TcpClientComponentBase object.

Definition at line 263 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 394 of file TcpClientComponentAc.cpp.

◆ deallocate_out()

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

protected

Invoke output port deallocate.

Parameters

portNum	The port number
fwBuffer	The buffer

Definition at line 409 of file TcpClientComponentAc.cpp.

◆ get_send_InputPort()

Drv::InputByteStreamSendPort * Drv::TcpClientComponentBase::get_send_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: send[portNum]

Parameters

portNum The port number

Definition at line 131 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 283 of file TcpClientComponentAc.cpp.

◆ getNum_deallocate_OutputPorts()

FwIndexType Drv::TcpClientComponentBase::getNum_deallocate_OutputPorts ( ) const

protected

Get the number of deallocate output ports

Returns: The number of deallocate output ports

Definition at line 289 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 295 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 301 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 273 of file TcpClientComponentAc.cpp.

◆ init()

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

Initialize TcpClientComponentBase object.

Parameters

instance The instance number

Definition at line 20 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 311 of file TcpClientComponentAc.cpp.

◆ isConnected_deallocate_OutputPort()

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

protected

Check whether port deallocate is connected

Returns: Whether port deallocate is connected

Parameters

portNum The port number

Definition at line 322 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 333 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 344 of file TcpClientComponentAc.cpp.

◆ lock()

void Drv::TcpClientComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 458 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 424 of file TcpClientComponentAc.cpp.

◆ recv_out()

void Drv::TcpClientComponentBase::recv_out	(	FwIndexType	portNum,
		Fw::Buffer &	recvBuffer,
		const Drv::RecvStatus &	recvStatus
	)

protected

Invoke output port recv.

Parameters

portNum The port number

Definition at line 434 of file TcpClientComponentAc.cpp.

◆ send_handler()

virtual Drv::SendStatus Drv::TcpClientComponentBase::send_handler	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protectedpure virtual

Handler for input port send.

Parameters

portNum	The port number
sendBuffer	Data to send

◆ send_handlerBase()

Drv::SendStatus Drv::TcpClientComponentBase::send_handlerBase	(	FwIndexType	portNum,
		Fw::Buffer &	sendBuffer
	)

protected

Handler base-class function for input port send.

Parameters

portNum	The port number
sendBuffer	Data to send

Definition at line 361 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 146 of file TcpClientComponentAc.cpp.

◆ set_deallocate_OutputPort()

void Drv::TcpClientComponentBase::set_deallocate_OutputPort	(	FwIndexType	portNum,
		Fw::InputBufferSendPort *	port
	)

Connect port to deallocate[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 160 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 174 of file TcpClientComponentAc.cpp.

◆ set_recv_OutputPort()

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

Connect port to recv[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 188 of file TcpClientComponentAc.cpp.

◆ unLock()

void Drv::TcpClientComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 464 of file TcpClientComponentAc.cpp.

Friends And Related Function Documentation

◆ TcpClientComponentBaseFriend

friend class TcpClientComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 34 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()

◆ deallocate_out()

◆ get_send_InputPort()

◆ getNum_allocate_OutputPorts()

◆ getNum_deallocate_OutputPorts()

◆ getNum_ready_OutputPorts()

◆ getNum_recv_OutputPorts()

◆ getNum_send_InputPorts()

◆ init()

◆ isConnected_allocate_OutputPort()

◆ isConnected_deallocate_OutputPort()

◆ isConnected_ready_OutputPort()

◆ isConnected_recv_OutputPort()

◆ lock()

◆ ready_out()

◆ recv_out()

◆ send_handler()

◆ send_handlerBase()

◆ set_allocate_OutputPort()

◆ set_deallocate_OutputPort()

◆ set_ready_OutputPort()

◆ set_recv_OutputPort()

◆ unLock()

Friends And Related Function Documentation

◆ TcpClientComponentBaseFriend