ifw-rtmstools 3.0.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ifw::rtmstools::llnetio::RtmsReceiverTool Class Reference

RtmsReceiverTool class/llnetio version. More...

#include <rtmsReceiverTool.hpp>

Inheritance diagram for ifw::rtmstools::llnetio::RtmsReceiverTool:
ifw::rtmstools::rtmslib_llnetio::RtmsReceiver

Public Member Functions

 RtmsReceiverTool (const std::string &receiver_ip, const std::string &interface_name, const int port, const ifw::fnd::datatype::DataType data_type, const ifw::rtmstools::rtmslib_llnetio::ReceiverConfig &rcv_cfg, uint32_t samples_requested)
 
virtual void HandleSampleUser (ifw::rtmstools::rtmslib_llnetio::SampleExtInfo &ext_info, std::vector< uint8_t > &sample_payload)
 User provided method to handle an RTMS Sample received.
 
std::string GenerateReport () const
 
- Public Member Functions inherited from ifw::rtmstools::rtmslib_llnetio::RtmsReceiver
 RtmsReceiver (const std::string &receiver_ip, const std::string &interface_name, const int port, const ifw::fnd::datatype::DataType data_type, const ReceiverConfig &rcv_cfg=ReceiverConfig())
 RTMS Receiver class.
 
virtual ~RtmsReceiver ()
 
void ReceiveLoop ()
 Receiver loop running until RtmsReceiver::StopReceiver() is invoked.
 
virtual void StopReceiver ()
 Signal to RTMS receiver to stop execution.
 
bool ReceiveSample (SampleExtInfo &ext_info, std::vector< uint8_t > &sample_payload, std::chrono::nanoseconds timeout)
 Receives one sample. Returns true if a sample received within the timeout.
 
int64_t GetLostFramesCount () const
 

Public Attributes

uint32_t m_samples_requested {0}
 
uint32_t m_samples_received {0}
 
uint32_t m_samples_lost {0}
 
unsigned int m_last_sample_id {0}
 
double m_last_heart_beat {0.0}
 

Additional Inherited Members

- Static Public Attributes inherited from ifw::rtmstools::rtmslib_llnetio::RtmsReceiver
static std::atomic< bool > s_execute = true
 
- Protected Member Functions inherited from ifw::rtmstools::rtmslib_llnetio::RtmsReceiver
int64_t GetSampleId () const
 
ifw::fnd::datatype::DataType GetDataType () const
 
ReceiverConfig GetConfig () const
 

Detailed Description

RtmsReceiverTool class/llnetio version.

RTMS receive class which merely receives the RTMS packets and keeps track of lost packets and samples and computes statistics.

Constructor & Destructor Documentation

◆ RtmsReceiverTool()

ifw::rtmstools::llnetio::RtmsReceiverTool::RtmsReceiverTool ( const std::string & receiver_ip,
const std::string & interface_name,
const int port,
const ifw::fnd::datatype::DataType data_type,
const ifw::rtmstools::rtmslib_llnetio::ReceiverConfig & rcv_cfg,
uint32_t samples_requested )

Member Function Documentation

◆ GenerateReport()

std::string ifw::rtmstools::llnetio::RtmsReceiverTool::GenerateReport ( ) const

◆ HandleSampleUser()

void ifw::rtmstools::llnetio::RtmsReceiverTool::HandleSampleUser ( ifw::rtmstools::rtmslib_llnetio::SampleExtInfo & ext_info,
std::vector< uint8_t > & sample_payload )
virtual

User provided method to handle an RTMS Sample received.

Parameters
ext_infoExtended Header Info.
sample_payloadImage data pixels.

Implements ifw::rtmstools::rtmslib_llnetio::RtmsReceiver.

Member Data Documentation

◆ m_last_heart_beat

double ifw::rtmstools::llnetio::RtmsReceiverTool::m_last_heart_beat {0.0}

◆ m_last_sample_id

unsigned int ifw::rtmstools::llnetio::RtmsReceiverTool::m_last_sample_id {0}

◆ m_samples_lost

uint32_t ifw::rtmstools::llnetio::RtmsReceiverTool::m_samples_lost {0}

◆ m_samples_received

uint32_t ifw::rtmstools::llnetio::RtmsReceiverTool::m_samples_received {0}

◆ m_samples_requested

uint32_t ifw::rtmstools::llnetio::RtmsReceiverTool::m_samples_requested {0}

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