LibFlute::Transmitter::FileDescription Class Reference

File Description object. More...

#include <Transmitter.h>

Public Types
enum	CompressionAlgorithm { COMPRESSION_NONE = 0 , COMPRESSION_GZIP , COMPRESSION_DEFLATE }
using	date_time_type = std::chrono::system_clock::time_point

Public Member Functions
	FileDescription ()=delete
	FileDescription (const std::string &content_location, const std::string &filename)
	Make a file description using the contents of a local file. More...
	FileDescription (const std::string &content_location, const char *data, size_t length)
	Make a file description using the contents of a memory buffer. More...
	FileDescription (const std::string &content_location)
	Make a file description without contents. More...
	FileDescription (const FileDescription &other)
	Copy constructor. More...
	FileDescription (FileDescription &&other)
	Move constructor. More...
virtual	~FileDescription ()
	Destructor. More...
FileDescription &	operator= (const FileDescription &other)
	Copy operator. More...
FileDescription &	operator= (FileDescription &&other)
	Move operator. More...
bool	operator== (const FileDescription &other) const
	Equality operator. More...
bool	has_tsi () const
	Has a Transmitter associated a TSI with this file? More...
uint64_t	tsi () const
	Get the associated TSI value. More...
uint32_t	toi () const
	Get the TOI associated with this file description. More...
const FileDeliveryTable::FileEntry &	file_entry () const
	Get the FDT file entry. More...
const char *	data ()
	Get the data to be transmitted. More...
size_t	data_length ()
	Get the length in bytes of the data to be transmitted. More...
FileDescription &	set_compression (CompressionAlgorithm compression)
	Set the compression algorithm. More...
FileDescription &	set_content_location (const std::string &location)
	Set Content-Location. More...
FileDescription &	set_content (const std::string &filename)
	Change the file contents using a local file. More...
FileDescription &	set_content (const char *data, size_t data_length)
	Change the file contents using a memory buffer. More...
FileDescription &	set_content_type (const std::string &content_type)
	Change the file content type. More...
FileDescription &	set_expiry_time (const date_time_type &expiry_time)
	Change the file expiry time. More...
date_time_type	get_expiry_time () const
	Get the currently set expiry time. More...
FileDescription &	set_etag (const std::string &etag)
	Set the ETag value for the file. More...
const std::string &	get_etag () const
	Get the current ETag value. More...
	FileDescription (const std::string &content_location, const std::vector< char > &data)
	Make a file description using the contents of a vector. More...
	FileDescription (const std::string &content_location, const std::vector< unsigned char > &data)
FileDescription &	set_content (const std::vector< char > &data)
	Change the file contents using a vector. More...
FileDescription &	set_content (const std::vector< unsigned char > &data)

Protected Member Functions
FileDescription &	tsi (uint64_t val)
	Set the TSI (used by the Transmitter class) More...
FileDescription &	toi (uint32_t val)
	Set the TOI (used by the Transmitter class) More...
uint32_t	previous_toi () const
	Get the TOI before reset. More...
FileDescription &	reset_previous_toi ()
	Reset the previous TOI value. More...
FileDescription &	merge_fec_oti (const FecOti &fec_oti)
	Merge the FecOti values. More...

Friends
class	Transmitter

Detailed Description

File Description object.

Definition at line 52 of file Transmitter.h.

Member Typedef Documentation

date_time_type

using LibFlute::Transmitter::FileDescription::date_time_type = std::chrono::system_clock::time_point

Definition at line 54 of file Transmitter.h.

Member Enumeration Documentation

CompressionAlgorithm

enum LibFlute::Transmitter::FileDescription::CompressionAlgorithm

Enumerator
COMPRESSION_NONE
COMPRESSION_GZIP
COMPRESSION_DEFLATE

Definition at line 56 of file Transmitter.h.

                                  {
          COMPRESSION_NONE = 0,  //< No compression
          COMPRESSION_GZIP,      //< Use gzip compression when encoding the file
          COMPRESSION_DEFLATE    //< Use deflate compression when encoding the file
        };

Constructor & Destructor Documentation

FileDescription() [1/8]

LibFlute::Transmitter::FileDescription::FileDescription ( )

delete

FileDescription() [2/8]

LibFlute::Transmitter::FileDescription::FileDescription	(	const std::string &	content_location,
		const std::string &	filename
	)

Make a file description using the contents of a local file.

Parameters

content_location	The URL to use as the content location in the FDT when sending the file
filename	The filename in the local filesystem of the file contents associated with this file description

Definition at line 63 of file Transmitter.cpp.

    : _tsi()
    , _file_entry({ .toi=0, .content_location=content_location})
    , _compression_type(Transmitter::FileDescription::COMPRESSION_NONE)
    , _filename()
    , _file_handle(-1)
    , _data(nullptr)
    , _data_length(0)
{
  _attach_file(filename);
  _calculate_file_entry();
}

FileDescription() [3/8]

LibFlute::Transmitter::FileDescription::FileDescription	(	const std::string &	content_location,
		const std::vector< char > &	data
	)

Make a file description using the contents of a vector.

This does not copy the data, it only retains a reference to it. It is up to the application to ensure that the data is retained in memory until it has finished with this file description and the Transmitter has finished sending the file.

Parameters

content_location	The URL to use as the content location in the FDT when sending the file
data	The vector containing the file contents

Definition at line 76 of file Transmitter.cpp.

    : _tsi()
    , _file_entry({ .toi=0, .content_location=content_location})
    , _compression_type(Transmitter::FileDescription::COMPRESSION_NONE)
    , _filename()
    , _file_handle(-1)
    , _data(data.data())
    , _data_length(data.size())
{
  _calculate_file_entry();
}

FileDescription() [4/8]

LibFlute::Transmitter::FileDescription::FileDescription	(	const std::string &	content_location,
		const std::vector< unsigned char > &	data
	)

Definition at line 88 of file Transmitter.cpp.

    : _tsi()
    , _file_entry({ .toi=0, .content_location=content_location})
    , _compression_type(Transmitter::FileDescription::COMPRESSION_NONE)
    , _filename()
    , _file_handle(-1)
    , _data(reinterpret_cast<const char*>(data.data()))
    , _data_length(data.size())
{
  _calculate_file_entry();
}

FileDescription() [5/8]

LibFlute::Transmitter::FileDescription::FileDescription	(	const std::string &	content_location,
		const char *	data,
		size_t	length
	)

Make a file description using the contents of a memory buffer.

This does not copy the data, it only retains a reference to it. It is up to the application to ensure that the data is retained in memory until it has finished with this file description and the Transmitter has finished sending the file.

Parameters

content_location	The URL to use as the content location in the FDT when sending the file
data	A pointer to the memory buffer containing the file contents
length	The size of the file contents in the memory buffer in bytes

Definition at line 100 of file Transmitter.cpp.

    : _tsi()
    , _file_entry({ .toi=0, .content_location=content_location})
    , _compression_type(Transmitter::FileDescription::COMPRESSION_NONE)
    , _filename()
    , _file_handle(-1)
    , _data(data)
    , _data_length(data?length:0)
{
  _calculate_file_entry();
}

FileDescription() [6/8]

LibFlute::Transmitter::FileDescription::FileDescription

(

const std::string &

content_location

)

Make a file description without contents.

Create a file description with just a URL location and no body content. The content can be added later using the set_content() methods.

Parameters

content_location

The URL to use as the content location in the FDT when sending the file

See also

set_content()

Definition at line 112 of file Transmitter.cpp.

    : _tsi()
    , _file_entry({ .toi=0, .content_location=content_location})
    , _compression_type(Transmitter::FileDescription::COMPRESSION_NONE)
    , _filename()
    , _file_handle(-1)
    , _data(nullptr)
    , _data_length(0)
{
  _calculate_file_entry();
}

FileDescription() [7/8]

LibFlute::Transmitter::FileDescription::FileDescription

(

const FileDescription &

other

)

Copy constructor.

This will make a copy of the file description.

Parameters

other

The other file description to copy

Definition at line 124 of file Transmitter.cpp.

    : _tsi(other._tsi)
    , _file_entry(other._file_entry)
    , _compression_type(other._compression_type)
    , _filename(other._filename)
    , _file_handle(-1)
    , _data(other._data)
    , _data_length(other._data_length)
{
  if (!_filename.empty()) {
    if (other._file_handle >= 0) {
      _file_handle = dup(other._file_handle);
    }
#if HAVE_MMAP
    // Map the file contents into memory
    _data = reinterpret_cast<char*>(mmap(nullptr, _data_length, PROT_READ, MAP_SHARED, _file_handle, 0));
#else
    // copy the file contents into a new memory block
    char *data = new char[_data_length];
    _data = data;
    memcpy(data, other._data, _data_length);
#endif
  }
}

FileDescription() [8/8]

LibFlute::Transmitter::FileDescription::FileDescription

(

Transmitter::FileDescription &&

other

)

Move constructor.

This will move the resources of the other file description into a new file description.

Parameters

other

The other file description to move

Definition at line 149 of file Transmitter.cpp.

    : _tsi(std::move(other._tsi))
    , _file_entry(other._file_entry)
    , _compression_type(other._compression_type)
    , _filename(std::move(other._filename))
    , _file_handle(other._file_handle)
    , _data(other._data)
    , _data_length(other._data_length)
{
  other._data = nullptr;
  other._data_length = 0;
  other._file_handle = -1;
}

~FileDescription()

LibFlute::Transmitter::FileDescription::~FileDescription ( )

virtual

Destructor.

Free all resources associated with this file description.

Definition at line 163 of file Transmitter.cpp.

{
  _free_file_data();
}

Member Function Documentation

data()

const char * LibFlute::Transmitter::FileDescription::data

(

)

Get the data to be transmitted.

This will apply the compression standard currently set to the contents and provide a transfer buffer.

Returns

The transfer data buffer pointer for the file contents. Use data_length() to get the transfer buffer size

See also

set_compression()

data_length()

Definition at line 229 of file Transmitter.cpp.

{
  return _data;
}

data_length()

size_t LibFlute::Transmitter::FileDescription::data_length

(

)

Get the length in bytes of the data to be transmitted.

This will apply the compression standard currently set to the contents and provide the resulting transfer buffer length.

Returns

The transfer data buffer length in bytes. Use data() to get the transfer buffer pointer

See also

set_compression()

data()

Definition at line 234 of file Transmitter.cpp.

{
  return _data_length;
}

file_entry()

const FileDeliveryTable::FileEntry& LibFlute::Transmitter::FileDescription::file_entry ( ) const

inline

Get the FDT file entry.

Returns

The current FDT File entry

Definition at line 193 of file Transmitter.h.

                                                             {
          return _file_entry;
        };

get_etag()

const std::string & LibFlute::Transmitter::FileDescription::get_etag

(

)

const

Get the current ETag value.

Returns

The current ETag value for the file

Definition at line 381 of file Transmitter.cpp.

{
  return _file_entry.etag;
}

get_expiry_time()

Transmitter::FileDescription::date_time_type LibFlute::Transmitter::FileDescription::get_expiry_time

(

)

const

Get the currently set expiry time.

Returns

the expiry time of this file.

Definition at line 369 of file Transmitter.cpp.

{
  auto durn = std::chrono::duration_cast<date_time_type::duration>(std::chrono::seconds(_file_entry.expires));
  return _get_ntp_epoch() + durn;
}

has_tsi()

bool LibFlute::Transmitter::FileDescription::has_tsi ( ) const

inline

Has a Transmitter associated a TSI with this file?

Returns

true if the TSI has been set

Definition at line 169 of file Transmitter.h.

{ return _tsi.has_value(); };

merge_fec_oti()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::merge_fec_oti ( const FecOti &  fec_oti )

protected

Merge the FecOti values.

Takes any values that are unset in _file_entry.fec_oti from fec_oti.

Parameters

fec_oti

The FecOti to merge values from.

Definition at line 386 of file Transmitter.cpp.

{
  if (static_cast<unsigned>(_file_entry.fec_oti.encoding_id) == 0) {
    _file_entry.fec_oti.encoding_id = fec_oti.encoding_id;
  }
  if (!_file_entry.fec_oti.instance_id) {
    _file_entry.fec_oti.instance_id = fec_oti.instance_id;
  }
  if (!_file_entry.fec_oti.transfer_length) {
    _file_entry.fec_oti.transfer_length = fec_oti.transfer_length;
  }
  if (!_file_entry.fec_oti.encoding_symbol_length) {
    _file_entry.fec_oti.encoding_symbol_length = fec_oti.encoding_symbol_length;
  }
  if (!_file_entry.fec_oti.max_source_block_length) {
    _file_entry.fec_oti.max_source_block_length = fec_oti.max_source_block_length;
  }
  if (!_file_entry.fec_oti.max_number_of_encoding_symbols) {
    _file_entry.fec_oti.max_number_of_encoding_symbols = fec_oti.max_number_of_encoding_symbols;
  }
  return *this;
}

operator=() [1/2]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::operator=

(

const FileDescription &

other

)

Copy operator.

This will make a copy of the other file description into this one.

Parameters

other

The other file description to copy

Returns

this file description

Definition at line 168 of file Transmitter.cpp.

{
  _tsi = other._tsi;
  _file_entry = other._file_entry;
  _compression_type = other._compression_type;
  _filename = other._filename;
  _file_handle = -1;
  _data = other._data;
  _data_length = other._data_length;
 
  if (!_filename.empty()) {
    if (other._file_handle >= 0) {
      _file_handle = dup(other._file_handle);
    }
#if HAVE_MMAP
    // Map the file contents into memory
    _data = reinterpret_cast<char*>(mmap(nullptr, _data_length, PROT_READ, MAP_SHARED, _file_handle, 0));
#else
    // copy the file contents into a new memory block
    char *data = new char[_data_length];
    _data = data;
    memcpy(data, other._data, _data_length);
#endif
  }
 
  return *this;
}

operator=() [2/2]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::operator=

(

Transmitter::FileDescription &&

other

)

Move operator.

This will move the resources of the other file description into this one.

Parameters

other

The other file description to move into this

Returns

this file description

Definition at line 196 of file Transmitter.cpp.

{
  _tsi = std::move(other._tsi);
  _file_entry = other._file_entry;
  _compression_type = other._compression_type;
  _filename = std::move(other._filename);
  _file_handle = other._file_handle;
  other._file_handle = -1;
 
  _data = other._data;
  other._data = nullptr;
  _data_length = other._data_length;
  other._data_length = 0;
 
  return *this;
}

operator==()

bool LibFlute::Transmitter::FileDescription::operator==

(

const FileDescription &

other

)

const

Equality operator.

Check if two file descriptions are equivalent

Definition at line 213 of file Transmitter.cpp.

{
  if (_tsi != other._tsi) return false;
  if (_compression_type != other._compression_type) return false;
 
  // _file_entry
  if (_file_entry != other._file_entry) return false;
 
  //if (_filename != other._filename) return false;
 
  if (_data_length != other._data_length) return false;
 
  if (_data == other._data) return true;
  return memcmp(_data, other._data, _data_length) == 0;
}

previous_toi()

uint32_t LibFlute::Transmitter::FileDescription::previous_toi ( ) const

inlineprotected

Get the TOI before reset.

Returns

The TOI as it was before the TOI was reset for file changes. 0 means no previous TOI.

Definition at line 342 of file Transmitter.h.

{ return _previous_toi; };

reset_previous_toi()

FileDescription& LibFlute::Transmitter::FileDescription::reset_previous_toi ( )

inlineprotected

Reset the previous TOI value.

Returns

this file description

Definition at line 349 of file Transmitter.h.

{ _previous_toi = 0; return *this; };

set_compression()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_compression

(

CompressionAlgorithm

compression

)

Set the compression algorithm.

This sets the compression algorithm that will be used to compress the file contents before sending. This will reset the TOI if the compression algorithm is changed.

Parameters

compression

The compression algorithm to set

Returns

this file description

Definition at line 250 of file Transmitter.cpp.

{
  if (compression != _compression_type) {
    _compression_type = compression;
    switch (_compression_type) {
    case COMPRESSION_GZIP:
      _file_entry.content_encoding = "gzip";
      break;
    case COMPRESSION_DEFLATE:
      _file_entry.content_encoding = "deflate";
      break;
    default:
      _file_entry.content_encoding.clear();
      break;
    }
    /* change in compression will change transmitted data, reset the TOI */
    _reset_toi();
    _calculate_file_entry();
  }
 
  return *this;
}

set_content() [1/4]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content	(	const char *	data,
		size_t	data_length
	)

Change the file contents using a memory buffer.

This will alter the contents associated with this file description and replace them with a reference to the memory buffer. It is up to the application to ensure that the data is retained in memory until it has finished with this file description and the Transmitter has finished sending the file. This will reset the TOI if the contents have changed.

Parameters

data	The in memory buffer to use for the new file contents
data_length	The length of the contents in the memory buffer

Returns

this file description

Definition at line 294 of file Transmitter.cpp.

{
  if (!data) data_length=0;
  if (data != _data || _data_length != data_length) {
    /* data area has changed in some way, do we need to reset the TOI? */
    if (_data_length != data_length) {
      /* data length has changed, reset the TOI */
      _reset_toi();
    } else if (data) {
      if (!_data) {
    if (data_length) {
          /* data being added, reset the TOI */
          _reset_toi();
        }
      } else if (data_length) {
        /* had data before and have new data now, but are they the same? */
        unsigned char md5[MD5_DIGEST_LENGTH];
        MD5(reinterpret_cast<const unsigned char*>(data), data_length, md5);
        if (_file_entry.content_md5 != base64_encode(md5, sizeof(md5))) {
          /* data contents are different, reset TOI */
          _reset_toi();
        }
      }
    } else if (_data) {
      /* data being removed, reset the TOI */
      _reset_toi();
    }
 
    _free_file_data();
    _data = data;
    _data_length = data_length;
    _calculate_file_entry();
  }
 
  return *this;
}

set_content() [2/4]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content

(

const std::string &

filename

)

Change the file contents using a local file.

This will alter the contents associated with this file description and replace them with the contents of the local file. This will reset the TOI if the contents have changed.

Parameters

filename

The local file path for the new contents

Returns

this file description

Definition at line 281 of file Transmitter.cpp.

{
  if (filename != _filename) {
    _free_file_data();
    _attach_file(filename);
    /* Assume a change of filename changes the contents too and zero the TOI */
    _reset_toi();
    _calculate_file_entry();
  }
 
  return *this;
}

set_content() [3/4]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content

(

const std::vector< char > &

data

)

Change the file contents using a vector.

This will alter the contents associated with this file description and replace them with a reference to the contents of the vector. It is up to the application to ensure that the data is retained in memory until it has finished with this file description and the Transmitter has finished sending the file. This will reset the TOI if the contents have changed.

Parameters

data	The vector to use for the new file contents

Returns

this file description

Definition at line 331 of file Transmitter.cpp.

{
  return set_content(data.data(), data.size());
}

set_content() [4/4]

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content

(

const std::vector< unsigned char > &

data

)

Definition at line 336 of file Transmitter.cpp.

{
  return set_content(reinterpret_cast<const char*>(data.data()), data.size());
}

set_content_location()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content_location

(

const std::string &

location

)

Set Content-Location.

Parameters

location

The location URL or filename.

Definition at line 274 of file Transmitter.cpp.

{
  _file_entry.content_location = location;
 
  return *this;
}

set_content_type()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_content_type

(

const std::string &

content_type

)

Change the file content type.

This will set the Content-Type that is associated with this file.

Parameters

content_type

The content type to set.

Returns

this file description

Definition at line 341 of file Transmitter.cpp.

{
  _file_entry.content_type = content_type;
  return *this;
}

set_etag()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_etag

(

const std::string &

etag

)

Set the ETag value for the file.

Set to the empty string to remove the ETag.

Parameters

etag	The ETag to set

Returns

this file description

Definition at line 375 of file Transmitter.cpp.

{
  _file_entry.etag = etag;
  return *this;
}

set_expiry_time()

Transmitter::FileDescription & LibFlute::Transmitter::FileDescription::set_expiry_time

(

const date_time_type &

expiry_time

)

Change the file expiry time.

Parameters

expiry_time

The expiry time of the file in the FLUTE session.

Returns

this file description

Definition at line 359 of file Transmitter.cpp.

{
  auto diff = std::chrono::duration_cast<std::chrono::seconds>(expiry_time - _get_ntp_epoch());
  _file_entry.expires = diff.count();
  _file_entry.cache_control.cache_expires = _file_entry.expires;
 
  return *this;
}

toi() [1/2]

uint32_t LibFlute::Transmitter::FileDescription::toi ( ) const

inline

Get the TOI associated with this file description.

This is meaningless if has_tsi() is false.

Returns

the TOI associated with this file description

Definition at line 186 of file Transmitter.h.

{ return _file_entry.toi; };

toi() [2/2]

FileDescription& LibFlute::Transmitter::FileDescription::toi ( uint32_t  val )

inlineprotected

Set the TOI (used by the Transmitter class)

Parameters

val	The new TOI value

Returns

this file description

Definition at line 335 of file Transmitter.h.

{ _file_entry.toi = val; return *this; };

tsi() [1/2]

uint64_t LibFlute::Transmitter::FileDescription::tsi ( ) const

inline

Get the associated TSI value.

Returns

the TSI value associated with this file description or 0 if not set

See also

has_tsi()

Definition at line 177 of file Transmitter.h.

{ return _tsi?_tsi.value():0; };

tsi() [2/2]

FileDescription& LibFlute::Transmitter::FileDescription::tsi ( uint64_t  val )

inlineprotected

Set the TSI (used by the Transmitter class)

Parameters

val	The new TSI value

Returns

this file description

Definition at line 328 of file Transmitter.h.

{ _tsi = val; return *this; };

Friends And Related Function Documentation

Transmitter

friend class Transmitter

friend

Definition at line 321 of file Transmitter.h.

---

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

• include/Transmitter.h
• src/Transmitter.cpp