Description

Processors that stop processing when a given event is received.

Functions
template<typename EventList, typename Downstream>
auto	tcspc::stop (std::string message_prefix, Downstream downstream)
	Create a processor that ends the stream when a given event type is received.
template<typename EventList, typename Exception = std::runtime_error, typename Downstream>
auto	tcspc::stop_with_error (std::string message_prefix, Downstream downstream)
	Create a processor that ends the stream with an error when a given event type is received.

Function Documentation

◆ stop()

template<typename EventList, typename Downstream>

auto tcspc::stop	(	std::string	message_prefix,
		Downstream	downstream )

Create a processor that ends the stream when a given event type is received.

If the triggering event type provides operator<< to std::ostream, the formatted event is appended to the exception message after message_prefix; otherwise the message consists of message_prefix only.

See also: tcspc::stop_with_error()

Template Parameters

EventList	event types that should cause stream to end
Downstream	downstream processor type

Parameters

message_prefix	error message prefix
downstream	downstream processor

Returns: processor

Events handled

Types in EventList: flush downstream and throw tcspc::end_of_processing
Types not in EventList: pass through with no action
Flush: pass through with no action

◆ stop_with_error()

template<typename EventList, typename Exception = std::runtime_error, typename Downstream>

auto tcspc::stop_with_error	(	std::string	message_prefix,
		Downstream	downstream )

Create a processor that ends the stream with an error when a given event type is received.