this class contains the description of the reconfiguration that must be carried out More...

#include <ReconfigurationMessage.hpp>

Public Member Functions
	ReconfigurationMessage (const SharedQueryId sharedQueryId, const DecomposedQueryId parentPlanId, const DecomposedQueryPlanVersion parentPlanVersion, ReconfigurationType type, ReconfigurablePtr instance=nullptr, std::any &&userdata=nullptr)
	create a reconfiguration task that will be used to kickstart the reconfiguration process More...

	ReconfigurationMessage (const SharedQueryId sharedQueryId, const DecomposedQueryId parentPlanId, const DecomposedQueryPlanVersion parentPlanVersion, ReconfigurationType type, uint64_t numThreads, ReconfigurablePtr instance, std::any &&userdata=nullptr, bool blocking=false)
	create a reconfiguration task that will be passed to every running thread More...

	ReconfigurationMessage (const ReconfigurationMessage &other, uint64_t numThreads, bool blocking=false)
	create a reconfiguration task that will be passed to every running thread More...

	ReconfigurationMessage (const ReconfigurationMessage &that)
	copy constructor More...

	~ReconfigurationMessage ()
	Destructor that calls destroy() More...

ReconfigurationType	getType () const
	get the reconfiguration type More...

SharedQueryId	getQueryId () const
	get the target plan id More...

DecomposedQueryId	getParentPlanId () const
	get the target plan id More...

DecomposedQueryPlanVersion	getParentPlanVersion () const

ReconfigurablePtr	getInstance () const
	get the target instance to reconfigura More...

void	wait ()
	issue a synchronization barrier for all threads More...

void	postReconfiguration ()
	callback executed after the reconfiguration is carried out More...

void	postWait ()
	issue a synchronization barrier for all threads More...

template<typename T >
T	getUserData () const
	Provides the userdata installed in this reconfiguration descriptor. More...

Detailed Description

this class contains the description of the reconfiguration that must be carried out

Constructor & Destructor Documentation

◆ ReconfigurationMessage() [1/4]

NES::Runtime::ReconfigurationMessage::ReconfigurationMessage	(	const SharedQueryId	sharedQueryId,
		const DecomposedQueryId	parentPlanId,
		const DecomposedQueryPlanVersion	parentPlanVersion,
		ReconfigurationType	type,
		ReconfigurablePtr	instance = `nullptr`,
		std::any &&	userdata = `nullptr`
	)

inlineexplicit

create a reconfiguration task that will be used to kickstart the reconfiguration process

Parameters

parentPlanId	the owning plan id
parentPlanVersion	the owning plan version
type	what kind of reconfiguration we want
instance	the target of the reconfiguration
userdata	extra information to use in this reconfiguration

References NES_ASSERT.

◆ ReconfigurationMessage() [2/4]

NES::Runtime::ReconfigurationMessage::ReconfigurationMessage	(	const SharedQueryId	sharedQueryId,
		const DecomposedQueryId	parentPlanId,
		const DecomposedQueryPlanVersion	parentPlanVersion,
		ReconfigurationType	type,
		uint64_t	numThreads,
		ReconfigurablePtr	instance,
		std::any &&	userdata = `nullptr`,
		bool	blocking = `false`
	)

inlineexplicit

create a reconfiguration task that will be passed to every running thread

Parameters

sharedQueryId	query id
parentPlanId	the owning plan id
parentPlanVersion	the owning plan version
type	reconfiguration type
instance	the target of the reconfiguration
userdata	extra information to use in this reconfiguration
blocking	whether the reconfiguration must block for completion

References NES_ASSERT.

◆ ReconfigurationMessage() [3/4]

NES::Runtime::ReconfigurationMessage::ReconfigurationMessage	(	const ReconfigurationMessage &	other,
		uint64_t	numThreads,
		bool	blocking = `false`
	)

inlineexplicit

create a reconfiguration task that will be passed to every running thread

Parameters

other	the task we want to issue (created using the other ctor)
numThreads	number of running threads
blocking	whether the reconfiguration must block for completion

References NES_ASSERT.

◆ ReconfigurationMessage() [4/4]

NES::Runtime::ReconfigurationMessage::ReconfigurationMessage ( const ReconfigurationMessage & that )

inline

copy constructor

Parameters

that

◆ ~ReconfigurationMessage()

NES::Runtime::ReconfigurationMessage::~ReconfigurationMessage ( )

inline

Destructor that calls destroy()

Member Function Documentation

◆ getInstance()

ReconfigurablePtr NES::Runtime::ReconfigurationMessage::getInstance ( ) const

inline

get the target instance to reconfigura

Returns: the target instance

◆ getParentPlanId()

DecomposedQueryId NES::Runtime::ReconfigurationMessage::getParentPlanId ( ) const

inline

get the target plan id

Returns: the plan id

Referenced by NES::Runtime::AbstractQueryManager::postReconfigurationCallback().

Here is the caller graph for this function:

◆ getParentPlanVersion()

DecomposedQueryPlanVersion NES::Runtime::ReconfigurationMessage::getParentPlanVersion ( ) const

inline

Referenced by NES::Runtime::AbstractQueryManager::postReconfigurationCallback().

Here is the caller graph for this function:

◆ getQueryId()

SharedQueryId NES::Runtime::ReconfigurationMessage::getQueryId ( ) const

inline

get the target plan id

Returns: the query id

◆ getType()

ReconfigurationType NES::Runtime::ReconfigurationMessage::getType ( ) const

inline

get the reconfiguration type

Returns: the reconfiguration type

Referenced by NES::Runtime::Execution::ExecutablePipeline::postReconfigurationCallback(), NES::Runtime::Execution::ExecutableQueryPlan::postReconfigurationCallback(), NES::Runtime::AbstractQueryManager::postReconfigurationCallback(), NES::Network::NetworkSink::postReconfigurationCallback(), NES::Network::NetworkSource::postReconfigurationCallback(), NES::SinkMedium::postReconfigurationCallback(), NES::Runtime::AbstractQueryManager::reconfigure(), NES::Runtime::Execution::ExecutablePipeline::reconfigure(), NES::Network::NetworkSource::reconfigure(), and NES::Network::NetworkSink::reconfigure().

Here is the caller graph for this function:

◆ getUserData()

template<typename T >

T NES::Runtime::ReconfigurationMessage::getUserData ( ) const

inline

Provides the userdata installed in this reconfiguration descriptor.

Template Parameters

T	the type of the reconfiguration's userdata

Returns: the user data value or error if that is not set

References NES_ASSERT2_FMT.

Referenced by NES::Network::NetworkSink::postReconfigurationCallback(), NES::Network::NetworkSource::postReconfigurationCallback(), NES::SinkMedium::postReconfigurationCallback(), NES::Runtime::Execution::ExecutablePipeline::reconfigure(), NES::Network::NetworkSource::reconfigure(), and NES::Network::NetworkSink::reconfigure().

Here is the caller graph for this function:

◆ postReconfiguration()

void NES::Runtime::ReconfigurationMessage::postReconfiguration ( )

callback executed after the reconfiguration is carried out

◆ postWait()

void NES::Runtime::ReconfigurationMessage::postWait ( )

issue a synchronization barrier for all threads

◆ wait()

void NES::Runtime::ReconfigurationMessage::wait ( )

issue a synchronization barrier for all threads

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

/nebulastream/nes-runtime/include/Runtime/ReconfigurationMessage.hpp
/nebulastream/nes-runtime/src/Runtime/ReconfigurationMessage.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReconfigurationMessage() [1/4]

◆ ReconfigurationMessage() [2/4]

◆ ReconfigurationMessage() [3/4]

◆ ReconfigurationMessage() [4/4]

◆ ~ReconfigurationMessage()

Member Function Documentation

◆ getInstance()

◆ getParentPlanId()

◆ getParentPlanVersion()

◆ getQueryId()

◆ getType()

◆ getUserData()

◆ postReconfiguration()

◆ postWait()

◆ wait()