LibFlute::Receiver Class Reference

FLUTE receiver class. More...

#include <Receiver.h>

Public Types
typedef std::function< void(std::shared_ptr< LibFlute::File >)>	completion_callback_t
	Definition of a file reception completion callback function that can be registered through ::register_completion_callback. More...

Public Member Functions
	Receiver (const std::string &iface, const std::string &address, short port, uint64_t tsi, boost::asio::io_context &io_context)
	Default constructor. More...
virtual	~Receiver ()=default
	Default destructor. More...
void	enable_ipsec (uint32_t spi, const std::string &aes_key)
	Enable IPSEC ESP decryption of FLUTE payloads. More...
std::vector< std::shared_ptr< LibFlute::File > >	file_list ()
	List all current files. More...
void	remove_expired_files (unsigned max_age)
	Remove files from the list that are older than max_age seconds. More...
void	remove_file_with_content_location (const std::string &cl)
	Remove a file from the list that matches the passed content location. More...
void	register_completion_callback (completion_callback_t cb)
	Register a callback for file reception notifications. More...
void	stop ()

Detailed Description

FLUTE receiver class.

Construct an instance of this to receive files from a FLUTE/ALC session.

Definition at line 29 of file Receiver.h.

Member Typedef Documentation

completion_callback_t

typedef std::function<void(std::shared_ptr<LibFlute::File>)> LibFlute::Receiver::completion_callback_t

Definition of a file reception completion callback function that can be registered through ::register_completion_callback.

Returns

shared_ptr to the received file

Definition at line 37 of file Receiver.h.

Constructor & Destructor Documentation

Receiver()

LibFlute::Receiver::Receiver	(	const std::string &	iface,
		const std::string &	address,
		short	port,
		uint64_t	tsi,
		boost::asio::io_context &	io_context
	)

Default constructor.

Parameters

iface	Address of the (local) interface to bind the receiving socket to. 0.0.0.0 = any.
address	Multicast address
port	Target port
tsi	TSI value of the session
io_context	Boost io_context to run the socket operations in (must be provided by the caller)

Definition at line 24 of file Receiver.cpp.

    : _socket(io_context)
    , _tsi(tsi)
    , _mcast_address(address)
{
    boost::asio::ip::udp::endpoint listen_endpoint(
        boost::asio::ip::make_address(iface), port);
    _socket.open(listen_endpoint.protocol());
    _socket.set_option(boost::asio::ip::multicast::enable_loopback(true));
    _socket.set_option(boost::asio::ip::udp::socket::reuse_address(true));
    _socket.set_option(boost::asio::socket_base::receive_buffer_size(16*1024*1024));
    _socket.bind(listen_endpoint);
 
    // Join the multicast group.
    _socket.set_option(
        boost::asio::ip::multicast::join_group(
          boost::asio::ip::make_address(address)));
 
    _socket.async_receive_from(
        boost::asio::buffer(_data, max_length), _sender_endpoint,
        boost::bind(&LibFlute::Receiver::handle_receive_from, this,
          boost::asio::placeholders::error,
          boost::asio::placeholders::bytes_transferred));
}

~Receiver()

virtual LibFlute::Receiver::~Receiver ( )

virtualdefault

Default destructor.

Member Function Documentation

enable_ipsec()

auto LibFlute::Receiver::enable_ipsec	(	uint32_t	spi,
		const std::string &	aes_key
	)

Enable IPSEC ESP decryption of FLUTE payloads.

Parameters

spi	Security Parameter Index value to use
key	AES key as a hex string (without leading 0x). Must be an even number of characters long.

Definition at line 51 of file Receiver.cpp.

{
  LibFlute::IpSec::enable_esp(spi, _mcast_address, LibFlute::IpSec::Direction::In, key);
}

file_list()

auto LibFlute::Receiver::file_list

(

)

List all current files.

Returns

Vector of all files currently in the FDT

Definition at line 150 of file Receiver.cpp.

{
  std::vector<std::shared_ptr<LibFlute::File>> files;
  for (auto& f : _files) {
    files.push_back(f.second);
  }
  return files;
}

register_completion_callback()

void LibFlute::Receiver::register_completion_callback ( completion_callback_t  cb )

inline

Register a callback for file reception notifications.

Parameters

cb	Function to call on file completion

Definition at line 86 of file Receiver.h.

{ _completion_cb = cb; };

remove_expired_files()

auto LibFlute::Receiver::remove_expired_files

(

unsigned

max_age

)

Remove files from the list that are older than max_age seconds.

Definition at line 159 of file Receiver.cpp.

{
  const std::lock_guard<std::mutex> lock(_files_mutex);
  for (auto it = _files.cbegin(); it != _files.cend();)
  {
    auto age = time(nullptr) - it->second->received_at();
    if ( it->second->meta().content_location != "bootstrap.multipart"  && age > max_age) {
      it = _files.erase(it);
    } else {
      ++it;
    }
  }
}

remove_file_with_content_location()

auto LibFlute::Receiver::remove_file_with_content_location

(

const std::string &

cl

)

Remove a file from the list that matches the passed content location.

Definition at line 173 of file Receiver.cpp.

{
  const std::lock_guard<std::mutex> lock(_files_mutex);
  for (auto it = _files.cbegin(); it != _files.cend();)
  {
    if ( it->second->meta().content_location == cl) {
      it = _files.erase(it);
    } else {
      ++it;
    }
  }
}

stop()

void LibFlute::Receiver::stop ( )

inline

Definition at line 88 of file Receiver.h.

{ _running = false; }

---

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

• include/Receiver.h
• src/Receiver.cpp