ts::TSProcessor Class Reference

Core of the TSP Transport Stream Processor. More...

#include <tsTSProcessor.h>

Inheritance diagram for ts::TSProcessor:

Collaboration diagram for ts::TSProcessor:

Public Member Functions
	TSProcessor (Report &report)
	Constructor.
	~TSProcessor ()
	Destructor.
void	abort ()
	Abort the processing.
void	callEventHandlers (const PluginEventContext &context) const
	Invoke all event handlers for a given event.
bool	isStarted ()
	Check if the TS processing is started.
void	registerEventHandler (PluginEventHandlerInterface *handler, const Criteria &criteria=Criteria::Any)
	Register an event handler.
Report &	report () const
	Get a reference to the report object for the TS processor.
bool	start (const TSProcessorArgs &args)
	Start the TS processing.
void	unregisterEventHandler (PluginEventHandlerInterface *handler=nullptr)
	Unregister all occurences of an event handler.
void	waitForTermination ()
	Suspend the calling thread until TS processing is completed.

Detailed Description

Core of the TSP Transport Stream Processor.

This class is used by the tsp utility. It can also be used in other applications to run a chain of plugins.

Constructor & Destructor Documentation

TSProcessor()

ts::TSProcessor::TSProcessor

(

Report &

report

)

Constructor.

Parameters

[in,out]

report

Where to report errors, logs, etc. This object will be used concurrently by all plugin execution threads. Consequently, it must be thread-safe. For performance reasons, it should be asynchronous (see for instance class AsyncReport).

~TSProcessor()

ts::TSProcessor::~TSProcessor

(

)

Destructor.

It waits for termination of the TS processing if it is running.

Member Function Documentation

report()

Report & ts::TSProcessor::report ( ) const

inline

Get a reference to the report object for the TS processor.

Returns

A reference to the report object for the TS processor.

start()

bool ts::TSProcessor::start

(

const TSProcessorArgs &

args

)

Start the TS processing.

Parameters

[in]

args

Arguments and options.

Returns

True on success, false on failure to start.

isStarted()

bool ts::TSProcessor::isStarted

(

)

Check if the TS processing is started.

Returns

True if the processing is in progress, false otherwise.

abort()

void ts::TSProcessor::abort

(

)

Abort the processing.

The method can be invoked from any thread, including an interrupt handler for instance.

registerEventHandler()

void ts::PluginEventHandlerRegistry::registerEventHandler ( PluginEventHandlerInterface *  handler, const Criteria &  criteria = Criteria::Any  )

inherited

Register an event handler.

Note: calling this function while executing a plugin event hander does nothing.

Parameters

[in]	handler	The event handler to register.
[in]	criteria	The criteria for which the handler is to be called.

unregisterEventHandler()

void ts::PluginEventHandlerRegistry::unregisterEventHandler ( PluginEventHandlerInterface *  handler = nullptr )

inherited

Unregister all occurences of an event handler.

Note: calling this function while executing a plugin event hander does nothing. This is typically used in the destructor of an event handler.

Parameters

[in]

handler

The event handler to unregister. When null, all events are unregistered.

callEventHandlers()

void ts::PluginEventHandlerRegistry::callEventHandlers ( const PluginEventContext &  context ) const

inherited

Invoke all event handlers for a given event.

Parameters

[in]

context

Event context.

---

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

• tsTSProcessor.h