spk::TContractProvider< TParameterTypes > Class Template Reference

Publishes callbacks (contracts) and allows blocking, delaying, or triggering them with arguments. More...

#include <spk_contract_provider.hpp>

Collaboration diagram for spk::TContractProvider< TParameterTypes >:

Classes
class	Blocker
	RAII helper that ignores or delays triggers while active. More...
class	Contract
	Handle to a subscribed job that can be resigned or triggered. More...

Public Types
using	Job = typename Contract::Job
	Alias to the subscribed callback signature.
using	VoidJob = std::function<void()>
	Callback used for providers without parameters.

Public Member Functions
	~TContractProvider ()
	Destroys the provider and invalidates all contracts.
	TContractProvider (const TContractProvider &)=delete
TContractProvider &	operator= (const TContractProvider &)=delete
	TContractProvider (TContractProvider &&p_other) noexcept
	Move-constructs, transferring subscriptions and state.
TContractProvider &	operator= (TContractProvider &&p_other) noexcept
	Move-assigns, releasing current contracts and adopting the source state.
Blocker	block (typename Blocker::Mode p_mode=Blocker::Mode::Ignore)
	Creates a blocker in the given mode.
void	invalidateContracts ()
	Invalidates and clears all contracts.
Contract	subscribe (const Job &p_job)
	Subscribes a job and returns its contract handle.
template<typename Dummy = void, typename = std::enable_if_t<(sizeof...(TParameterTypes) > 0), Dummy>>
Contract	subscribe (const VoidJob &p_job)
	Subscribes a job without parameters, wrapping it to match the signature.
void	relinquish (Contract &&p_contract)
	Moves a contract into the relinquished list (no immediate unsubscribe).
void	unsubscribe (const Contract &p_contract)
	Unsubscribes a contract, removing it from the list.
void	trigger (TParameterTypes... p_args) const
	Triggers all subscribed jobs unless blocked/delayed.
size_t	nbContracts () const
	Returns the number of currently subscribed contracts.

Detailed Description

template<typename... TParameterTypes>
class spk::TContractProvider< TParameterTypes >

Publishes callbacks (contracts) and allows blocking, delaying, or triggering them with arguments.

Template Parameters

TParameterTypes

Parameter pack forwarded to subscribed jobs.

spk::TContractProvider<int> provider;
auto contract = provider.subscribe([](int v){ handleValue(v); });
provider.trigger(5);

Constructor & Destructor Documentation

TContractProvider()

template<typename... TParameterTypes>

spk::TContractProvider< TParameterTypes >::TContractProvider ( TContractProvider< TParameterTypes > && p_other )

inlinenoexcept

Move-constructs, transferring subscriptions and state.

Parameters

p_other

Source provider.

Member Function Documentation

block()

template<typename... TParameterTypes>

Blocker spk::TContractProvider< TParameterTypes >::block ( typename Blocker::Mode p_mode = Blocker::Mode::Ignore )

inline

Creates a blocker in the given mode.

Parameters

p_mode

Ignore drops triggers; Delay queues one trigger until unblocked.

Returns

RAII Blocker that releases on destruction.

nbContracts()

template<typename... TParameterTypes>

size_t spk::TContractProvider< TParameterTypes >::nbContracts ( ) const

inline

Returns the number of currently subscribed contracts.

Returns

Contract count.

operator=()

template<typename... TParameterTypes>

TContractProvider & spk::TContractProvider< TParameterTypes >::operator= ( TContractProvider< TParameterTypes > && p_other )

inlinenoexcept

Move-assigns, releasing current contracts and adopting the source state.

Parameters

p_other

Source provider.

Returns

*this.

relinquish()

template<typename... TParameterTypes>

void spk::TContractProvider< TParameterTypes >::relinquish ( Contract && p_contract )

inline

Moves a contract into the relinquished list (no immediate unsubscribe).

Parameters

p_contract

Contract to relinquish.

subscribe() [1/2]

template<typename... TParameterTypes>

Contract spk::TContractProvider< TParameterTypes >::subscribe ( const Job & p_job )

inline

Subscribes a job and returns its contract handle.

Parameters

p_job

Callback to invoke on trigger.

Returns

Contract managing the subscription.

Here is the caller graph for this function:

subscribe() [2/2]

template<typename... TParameterTypes>

template<typename Dummy = void, typename = std::enable_if_t<(sizeof...(TParameterTypes) > 0), Dummy>>

Contract spk::TContractProvider< TParameterTypes >::subscribe ( const VoidJob & p_job )

inline

Subscribes a job without parameters, wrapping it to match the signature.

Parameters

p_job

Callback without parameters.

Returns

Contract managing the subscription.

trigger()

template<typename... TParameterTypes>

void spk::TContractProvider< TParameterTypes >::trigger ( TParameterTypes... p_args ) const

inline

Triggers all subscribed jobs unless blocked/delayed.

Parameters

p_args

Arguments forwarded to each job.

unsubscribe()

template<typename... TParameterTypes>

void spk::TContractProvider< TParameterTypes >::unsubscribe ( const Contract & p_contract )

inline

Unsubscribes a contract, removing it from the list.

Parameters

p_contract

Contract to remove.

---

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

• includes/structure/design_pattern/spk_contract_provider.hpp