ts::PluginEventHandlerRegistry::Criteria Class Reference

Registration criteria for an event handler. More...

#include <tsPluginEventHandlerRegistry.h>

Collaboration diagram for ts::PluginEventHandlerRegistry::Criteria:

Public Member Functions
	Criteria ()=default
	Default constructor.
	Criteria (const UString &name)
	Constructor with a plugin name.
	Criteria (PluginType type)
	Constructor with a plugin type.
	Criteria (uint32_t code)
	Constructor with an event code.

Public Attributes
std::optional< uint32_t >	event_code {}
	When specified, the event must use that code.
std::optional< size_t >	plugin_index {}
	When specified, the plugin must be at that index in the chain.
std::optional< UString >	plugin_name {}
	When specified, the plugin must match that name.
std::optional< PluginType >	plugin_type {}
	When specified, the plugin must be of this type.

Static Public Attributes
static const Criteria	Any
	A common empty criteria, meaning "any event".

Detailed Description

Registration criteria for an event handler.

A handler can be registered for any combination of:

• Plugin name
• Plugin index in the chain
• Plugin type (input, packet processing, output).
• Event code (32-bit plugin-specific value).
• All plugins (when no criteria is specified).

Constructor & Destructor Documentation

Criteria() [1/4]

ts::PluginEventHandlerRegistry::Criteria::Criteria ( )

default

Default constructor.

No criteria is set, meaning it matches all events.

Criteria() [2/4]

ts::PluginEventHandlerRegistry::Criteria::Criteria ( uint32_t  code )

inline

Constructor with an event code.

It matches all events with that code from any plugin.

Parameters

[in]

code

Event code.

Criteria() [3/4]

ts::PluginEventHandlerRegistry::Criteria::Criteria ( PluginType  type )

inline

Constructor with a plugin type.

It matches all events from any plugin of that type.

Parameters

[in]

type

Plugin type.

Criteria() [4/4]

ts::PluginEventHandlerRegistry::Criteria::Criteria ( const UString &  name )

inline

Constructor with a plugin name.

It matches all events from any plugin of that name.

Parameters

[in]

name

Plugin name.

---

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

• tsPluginEventHandlerRegistry.h