Abstract base class for TLV messages. More...

#include <tstlvMessage.h>

Inheritance diagram for ts::tlv::Message:

[legend]

Public Member Functions
virtual UString	dump (size_t indent=0) const
	Dump routine.

void	forceProtocolVersion (VERSION version)
	Force the protocol version number to another value.

bool	hasProtocolVersion () const
	Check if the message has a protocol version number.

VERSION	protocolVersion () const
	Get the protocol version number.

void	serialize (Serializer &zer) const
	Serialize the message using a Serializer.

TAG	tag () const
	Get the message tag.

Protected Types
using	superclass = Message
	Alias for the superclass of subclasses.

Protected Member Functions
	Message (TAG tag)
	Protected constructor for subclasses.

	Message (VERSION protocol_version, TAG tag)
	Protected constructor for subclasses.

virtual void	serializeParameters (Serializer &zer) const =0
	Parameter serialization.

Static Protected Member Functions
template<typename INT > requires std::integral<INT>
static UString	dumpDecimal (size_t indent, const UString &name, const INT &value)
	Dump an integer value in decimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpHexa (size_t indent, const UString &name, const INT &value)
	Dump an integer value in hexadecimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpInteger (size_t indent, const UString &name, const INT &value)
	Dump an integer value (helper routine for subclasses).

static UString	dumpOptional (size_t indent, const UString &name, bool has_value, const ByteBlock &value, uint32_t flags=UString::HEXA\|UString::ASCII)
	Dump an optional byte block (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalDecimal (size_t indent, const UString &name, bool has_value, const INT &value)
	Dump an optional integer value in decimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalDecimal (size_t indent, const UString &name, const std::optional< INT > &value)
	Dump an optional integer value in decimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalHexa (size_t indent, const UString &name, bool has_value, const INT &value)
	Dump an optional integer value in hexadecimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalHexa (size_t indent, const UString &name, const std::optional< INT > &value)
	Dump an optional integer value in hexadecimal (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalInteger (size_t indent, const UString &name, bool has_value, const INT &value)
	Dump an optional integer value (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpOptionalInteger (size_t indent, const UString &name, const std::optional< INT > &value)
	Dump an optional integer value (helper routine for subclasses).

template<typename INT > requires std::integral<INT>
static UString	dumpVector (size_t indent, const UString &name, const std::vector< INT > &val, UString(*toString)(INT)=nullptr)
	Dump a vector of integer values (helper routine for subclasses).

static UString	dumpVector (size_t indent, const UString &name, const UStringVector &value)
	Dump a vector of strings (helper routine for subclasses).

Detailed Description

Abstract base class for TLV messages.

All messages use the same structure as the DVB interfaces defined in the "DVB Simulcrypt Head End" standard, that is to say a TLV protocol. The messages shall have the same generic format as all connection-oriented TLV DVB Simulcrypt protocols and illustrated as follow:

generic_message
{
    protocol_version      1 byte
    message_type          2 bytes
    message_length        2 bytes
    for (i=0; i < n; i++)
    {
        parameter_type    2 bytes
        parameter_length  2 bytes
        parameter_value   <parameter_length> bytes
    }
}

The protocols use the same byte order and parameter order as DVB Simulcrypt protocols: For parameters with a size two or more bytes, the first byte to be transmitted will be the most significant byte. This is commonly known as "big endian" or "MSB first". Parameters do not need to be ordered within the generic message.

Constructor & Destructor Documentation

◆ Message() [1/2]

ts::tlv::Message::Message ( TAG tag )

protected

Protected constructor for subclasses.

Parameters

[in] tag Message tag.

◆ Message() [2/2]

ts::tlv::Message::Message	(	VERSION	protocol_version,
		TAG	tag
	)

protected

Protected constructor for subclasses.

Parameters

[in]	protocol_version	Protocol version.
[in]	tag	Message tag.

Member Function Documentation

◆ hasProtocolVersion()

bool ts::tlv::Message::hasProtocolVersion ( ) const

inline

Check if the message has a protocol version number.

Returns: True if the message has a protocol version number.

◆ protocolVersion()

VERSION ts::tlv::Message::protocolVersion ( ) const

inline

Get the protocol version number.

Returns: The protocol version number.

◆ forceProtocolVersion()

void ts::tlv::Message::forceProtocolVersion ( VERSION version )

inline

Force the protocol version number to another value.

Use with care.

Parameters

[in] version The protocol version number.

◆ tag()

TAG ts::tlv::Message::tag ( ) const

inline

Get the message tag.

Returns: The message tag.

◆ serialize()

void ts::tlv::Message::serialize ( Serializer & zer ) const

Serialize the message using a Serializer.

Parameters

[in,out] zer A TLV serializer.

◆ dump()

virtual UString ts::tlv::Message::dump ( size_t indent = 0 ) const

virtual

Dump routine.

Create a string representing the message content. The implementation in the base class dumps the common fields. Can be used by subclasses.

Parameters

[in] indent Left indentation size.

Returns: A string representing the message.

Reimplemented in ts::duck::LogSection, ts::duck::LogTable, ts::duck::ClearECM, ts::duck::Error, ts::ecmgscs::ChannelSetup, ts::ecmgscs::ChannelTest, ts::ecmgscs::ChannelStatus, ts::ecmgscs::ChannelClose, ts::ecmgscs::ChannelError, ts::ecmgscs::StreamSetup, ts::ecmgscs::StreamTest, ts::ecmgscs::StreamStatus, ts::ecmgscs::StreamCloseRequest, ts::ecmgscs::StreamCloseResponse, ts::ecmgscs::StreamError, ts::ecmgscs::CWProvision, ts::ecmgscs::ECMResponse, ts::emmgmux::ChannelSetup, ts::emmgmux::ChannelTest, ts::emmgmux::ChannelStatus, ts::emmgmux::ChannelClose, ts::emmgmux::ChannelError, ts::emmgmux::StreamSetup, ts::emmgmux::StreamTest, ts::emmgmux::StreamStatus, ts::emmgmux::StreamCloseRequest, ts::emmgmux::StreamCloseResponse, ts::emmgmux::StreamError, ts::emmgmux::StreamBWRequest, ts::emmgmux::StreamBWAllocation, and ts::emmgmux::DataProvision.

◆ serializeParameters()

virtual void ts::tlv::Message::serializeParameters ( Serializer & zer ) const

protectedpure virtual

Parameter serialization.

This protected pure virtual method must be implemented by subclasses to serialize their parameters.

Parameters

[in,out] zer A TLV serializer.

Implemented in ts::duck::LogSection, ts::duck::LogTable, ts::duck::ClearECM, ts::duck::Error, ts::ecmgscs::ChannelSetup, ts::ecmgscs::ChannelTest, ts::ecmgscs::ChannelStatus, ts::ecmgscs::ChannelClose, ts::ecmgscs::ChannelError, ts::ecmgscs::StreamSetup, ts::ecmgscs::StreamTest, ts::ecmgscs::StreamStatus, ts::ecmgscs::StreamCloseRequest, ts::ecmgscs::StreamCloseResponse, ts::ecmgscs::StreamError, ts::ecmgscs::CWProvision, ts::ecmgscs::ECMResponse, ts::emmgmux::ChannelSetup, ts::emmgmux::ChannelTest, ts::emmgmux::ChannelStatus, ts::emmgmux::ChannelClose, ts::emmgmux::ChannelError, ts::emmgmux::StreamSetup, ts::emmgmux::StreamTest, ts::emmgmux::StreamStatus, ts::emmgmux::StreamCloseRequest, ts::emmgmux::StreamCloseResponse, ts::emmgmux::StreamError, ts::emmgmux::StreamBWRequest, ts::emmgmux::StreamBWAllocation, and ts::emmgmux::DataProvision.

◆ dumpVector() [1/2]

static UString ts::tlv::Message::dumpVector	(	size_t	indent,
		const UString &	name,
		const UStringVector &	value
	)

staticprotected

Dump a vector of strings (helper routine for subclasses).

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Vector of strings.

Returns: The formatted string with embedded new-lines.

◆ dumpOptional()

static UString ts::tlv::Message::dumpOptional	(	size_t	indent,
		const UString &	name,
		bool	has_value,
		const ByteBlock &	value,
		uint32_t	flags = `UString::HEXA\|UString::ASCII`
	)

staticprotected

Dump an optional byte block (helper routine for subclasses).

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	has_value	If false, no value is available, return an empty string.
[in]	value	Byte block.
[in]	flags	Hexa dump flags for ts::Hexa().

Returns: The formatted string with embedded new-lines.

◆ dumpDecimal()

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpDecimal	(	size_t	indent,
		const UString &	name,
		const INT &	value
	)

inlinestaticprotected

Dump an integer value in decimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpHexa()

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpHexa	(	size_t	indent,
		const UString &	name,
		const INT &	value
	)

inlinestaticprotected

Dump an integer value in hexadecimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpInteger()

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpInteger	(	size_t	indent,
		const UString &	name,
		const INT &	value
	)

inlinestaticprotected

Dump an integer value (helper routine for subclasses).

Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalDecimal() [1/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalDecimal	(	size_t	indent,
		const UString &	name,
		bool	has_value,
		const INT &	value
	)

inlinestaticprotected

Dump an optional integer value in decimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	has_value	If false, no value is available, return an empty string.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalDecimal() [2/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalDecimal	(	size_t	indent,
		const UString &	name,
		const std::optional< INT > &	value
	)

inlinestaticprotected

Dump an optional integer value in decimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalHexa() [1/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalHexa	(	size_t	indent,
		const UString &	name,
		bool	has_value,
		const INT &	value
	)

inlinestaticprotected

Dump an optional integer value in hexadecimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	has_value	If false, no value is available, return an empty string.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalHexa() [2/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalHexa	(	size_t	indent,
		const UString &	name,
		const std::optional< INT > &	value
	)

inlinestaticprotected

Dump an optional integer value in hexadecimal (helper routine for subclasses).

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalInteger() [1/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalInteger	(	size_t	indent,
		const UString &	name,
		bool	has_value,
		const INT &	value
	)

inlinestaticprotected

Dump an optional integer value (helper routine for subclasses).

Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	has_value	If false, no value is available, return an empty string.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpOptionalInteger() [2/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpOptionalInteger	(	size_t	indent,
		const UString &	name,
		const std::optional< INT > &	value
	)

inlinestaticprotected

Dump an optional integer value (helper routine for subclasses).

Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	value	Integer value.

Returns: The formatted string with embedded new-lines.

◆ dumpVector() [2/2]

template<typename INT >
requires std::integral<INT>

static UString ts::tlv::Message::dumpVector	(	size_t	indent,
		const UString &	name,
		const std::vector< INT > &	val,
		UString(*)(INT)	toString = `nullptr`
	)

staticprotected

Dump a vector of integer values (helper routine for subclasses).

Signed integer types are dumped in decimal, unsigned types in hexadecimal.

Template Parameters

INT	An integer type.

Parameters

[in]	indent	Left indentation size.
[in]	name	Parameter name.
[in]	val	Vector of integer values.
[in]	toString	Optional function to convert an INT value into a string.

Returns: The formatted string with embedded new-lines.

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

tstlvMessage.h

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Message() [1/2]

◆ Message() [2/2]

Member Function Documentation

◆ hasProtocolVersion()

◆ protocolVersion()

◆ forceProtocolVersion()

◆ tag()

◆ serialize()

◆ dump()

◆ serializeParameters()

◆ dumpVector() [1/2]

◆ dumpOptional()

◆ dumpDecimal()

◆ dumpHexa()

◆ dumpInteger()

◆ dumpOptionalDecimal() [1/2]

◆ dumpOptionalDecimal() [2/2]

◆ dumpOptionalHexa() [1/2]

◆ dumpOptionalHexa() [2/2]

◆ dumpOptionalInteger() [1/2]

◆ dumpOptionalInteger() [2/2]

◆ dumpVector() [2/2]