ccf::tools::rtms2ccflib::RtmsCcfReceiver Class Reference

The RtmsCcfReceiver struct receives RTMS packets and package these in ccf::common::DataFrame objects. More...

#include <rtmsCcfReceiver.hpp>

Inheritance diagram for ccf::tools::rtms2ccflib::RtmsCcfReceiver:

Public Member Functions
	RtmsCcfReceiver (std::string address, int port, std::string net_if, int width, int height, int bpp, ccf::DataTypes data_type, int queue_size=10)
virtual	~RtmsCcfReceiver ()
virtual void	HandleLeaderPacket ()
	Invoked to handle a MUDPI/RTMS Leader Packet. More...
virtual void	HandlePayloadPacket (mudpiif::mudpiPacketJumbo &packet)
	Invoked to handle a MUDPI/RTMS Payload Packet. More...
virtual void	HandleTrailerPacket ()
	Invoked to handle a MUDPI/RTMS Trailer Packet. More...
virtual void	HandleLostPackets ()
	Handle the case where packets are lost. More...
virtual void	HandleWrongFrameId ()
	Handle the case where a wrong frame ID is received. More...
void	GetFrame (ccf::common::DataFrame &data_frame, double timeout, bool &frame_received, bool &timed_out)
	Receive one RTMS frame. More...

Public Attributes
int	m_packet_timeout = 1000
ccf::common::FrameQueue *	m_frame_queue = nullptr
ccf::common::DataFrame *	m_cur_input_frame = nullptr
int	m_client_frame_index = 0
ccf::DataTypes	m_data_type
uint16_t	m_queue_size = -1
uint16_t	m_receiver_index = 0

Detailed Description

The RtmsCcfReceiver struct receives RTMS packets and package these in ccf::common::DataFrame objects.

RTMS receiver which receives RTMS packets into ccf::common::DataFrame objects.

Constructor & Destructor Documentation

RtmsCcfReceiver()

ccf::tools::rtms2ccflib::RtmsCcfReceiver::RtmsCcfReceiver	(	std::string	address,
		int	port,
		std::string	net_if,
		int	width,
		int	height,
		int	bpp,
		ccf::DataTypes	data_type,
		int	queue_size = 10
	)

~RtmsCcfReceiver()

ccf::tools::rtms2ccflib::RtmsCcfReceiver::~RtmsCcfReceiver ( )

virtual

Member Function Documentation

GetFrame()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::GetFrame	(	ccf::common::DataFrame &	data_frame,
		double	timeout,
		bool &	frame_received,
		bool &	timed_out
	)

Receive one RTMS frame.

HandleLeaderPacket()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::HandleLeaderPacket ( )

virtual

Invoked to handle a MUDPI/RTMS Leader Packet.

HandleLostPackets()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::HandleLostPackets ( )

virtual

Handle the case where packets are lost.

HandlePayloadPacket()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::HandlePayloadPacket ( mudpiif::mudpiPacketJumbo &  packet )

virtual

Invoked to handle a MUDPI/RTMS Payload Packet.

HandleTrailerPacket()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::HandleTrailerPacket ( )

virtual

Invoked to handle a MUDPI/RTMS Trailer Packet.

HandleWrongFrameId()

void ccf::tools::rtms2ccflib::RtmsCcfReceiver::HandleWrongFrameId ( )

virtual

Handle the case where a wrong frame ID is received.

Member Data Documentation

m_client_frame_index

int ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_client_frame_index = 0

m_cur_input_frame

ccf::common::DataFrame* ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_cur_input_frame = nullptr

m_data_type

ccf::DataTypes ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_data_type

m_frame_queue

ccf::common::FrameQueue* ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_frame_queue = nullptr

m_packet_timeout

int ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_packet_timeout = 1000

m_queue_size

uint16_t ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_queue_size = -1

m_receiver_index

uint16_t ccf::tools::rtms2ccflib::RtmsCcfReceiver::m_receiver_index = 0

---

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

• tools/rtms2ccflib/src/include/rtms2ccflib/rtmsCcfReceiver.hpp
• tools/rtms2ccflib/src/rtmsCcfReceiver.cpp