ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver Class Reference

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

#include <rtmsCcfReceiver.hpp>

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

Public Member Functions
	RtmsCcfReceiver (const std::string &receiver_ip, const std::string &interface_name, const int port, const ifw::fnd::datatype::DataType data_type, const int width, const int height, int queue_size, const uint16_t mtu_size, const ifw::rtmslib::ExtendedInfoMode ext_info_mode, const int32_t topic_id)
	RTMS Receiver class.
virtual	~RtmsCcfReceiver ()
virtual void	HandleSampleUser (ifw::rtmslib::SampleExtInfo &ext_info, std::vector< uint8_t > &sample_payload)
	User provided method to handle an RTMS Sample received. The received sample will be stored in the frame queue until it is read by a client.
void	GetFrame (ifw::ccf::common::DataFrame &data_frame, double timeout, bool &frame_received, bool &timed_out)
	Return the most recent frame in the queue.
virtual void	StopReceiver ()

Public Attributes
ifw::ccf::common::FrameQueue *	m_frame_queue {nullptr}
	Frames buffer.
ifw::ccf::common::DataFrame *	m_cur_input_frame {nullptr}
	Last receive frame in the queue.
uint16_t	m_queue_size {0}
uint16_t	m_receiver_index {0}

Detailed Description

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

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

Constructor & Destructor Documentation

RtmsCcfReceiver()

ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::RtmsCcfReceiver	(	const std::string &	receiver_ip,
		const std::string &	interface_name,
		const int	port,
		const ifw::fnd::datatype::DataType	data_type,
		const int	width,
		const int	height,
		int	queue_size,
		const uint16_t	mtu_size,
		const ifw::rtmslib::ExtendedInfoMode	ext_info_mode,
		const int32_t	topic_id )

RTMS Receiver class.

Parameters

receiver_ip	ip where packets are received (unicast or multicast)
interface_name	Name of the network interface where the packets are received (for multicast case).
port	Port used for the UDP socket.
data_type	Type of data received.
rcv_cfg	Additional configuration data for the receiver.

~RtmsCcfReceiver()

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

virtual

Member Function Documentation

GetFrame()

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

Return the most recent frame in the queue.

Parameters

data_frame	most recent frame
timeout	timeout for getting a frame
frame_received	frame received flag
timed_out	flag

HandleSampleUser()

void ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::HandleSampleUser ( ifw::rtmslib::SampleExtInfo & ext_info, std::vector< uint8_t > & sample_payload )

virtual

User provided method to handle an RTMS Sample received. The received sample will be stored in the frame queue until it is read by a client.

Parameters

ext_info	Extended Header Info.
sample_payload	Image data pixels.

StopReceiver()

void ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::StopReceiver ( )

virtual

Member Data Documentation

m_cur_input_frame

ifw::ccf::common::DataFrame* ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::m_cur_input_frame {nullptr}

Last receive frame in the queue.

m_frame_queue

ifw::ccf::common::FrameQueue* ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::m_frame_queue {nullptr}

Frames buffer.

m_queue_size

uint16_t ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::m_queue_size {0}

m_receiver_index

uint16_t ifw::ccf::tools::llnetio::rtms2ccflib::RtmsCcfReceiver::m_receiver_index {0}

---

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

• tools/rtms2ccflib_llnetio/src/include/ifw/ccf/tools/rtms2ccflib_llnetio/rtmsCcfReceiver.hpp
• tools/rtms2ccflib_llnetio/src/rtmsCcfReceiver.cpp