Bloomberg::quantum::IThreadPromise< PROMISE, T > Interface Template Reference

Exposes methods to access and manipulate a non-coroutine promise (i.e. used in a thread) More...

#include <quantum_ithread_promise.h>

Inheritance diagram for Bloomberg::quantum::IThreadPromise< PROMISE, T >:

Public Types
using	ContextTag = ThreadContextTag
using	Ptr = std::shared_ptr< IThreadPromise< PROMISE, T > >
using	Impl = PROMISE< T >

Public Member Functions
	IThreadPromise (Impl *derived)
	Constructor. More...
virtual ThreadFuturePtr< T >	getIThreadFuture () const =0
	Get the associated thread future. More...
template<class V , class = NonBufferType<T,V>>
int	set (V &&value)
	Set the promised value. More...
template<class V , class = BufferType<T,V>>
void	push (V &&value)
	Push a single value into the promise buffer. More...
template<class V = T, class = BufferRetType<V>>
int	closeBuffer ()
	Close a promise buffer. More...
Public Member Functions inherited from Bloomberg::quantum::Traits::DerivedFrom< PROMISE< T >, IThreadPromise< PROMISE, T >, IPromiseBase >
virtual	~DerivedFrom ()=default
	operator IPromiseBase * ()
	operator IPromiseBase & ()

Detailed Description

template<template< class > class PROMISE, class T>
interface Bloomberg::quantum::IThreadPromise< PROMISE, T >

Exposes methods to access and manipulate a non-coroutine promise (i.e. used in a thread)

Template Parameters

PROMISE	The derived promise (concrete type).
T	The type of value contained in this promise.

Member Typedef Documentation

ContextTag

template<template< class > class PROMISE, class T>

using Bloomberg::quantum::IThreadPromise< PROMISE, T >::ContextTag = ThreadContextTag

Impl

template<template< class > class PROMISE, class T>

using Bloomberg::quantum::IThreadPromise< PROMISE, T >::Impl = PROMISE<T>

Ptr

template<template< class > class PROMISE, class T>

using Bloomberg::quantum::IThreadPromise< PROMISE, T >::Ptr = std::shared_ptr<IThreadPromise<PROMISE, T> >

Constructor & Destructor Documentation

IThreadPromise()

template<template< class > class PROMISE, class T>

Bloomberg::quantum::IThreadPromise< PROMISE, T >::IThreadPromise ( Impl *  derived )

inline

Constructor.

Parameters

[in]

derived

A pointer to the concrete implementation of this class.

Note

The constructor parameter is only used for template deduction at compile time.

Member Function Documentation

closeBuffer()

template<template< class > class PROMISE, class T >

template<class V , class >

int Bloomberg::quantum::IThreadPromise< PROMISE, T >::closeBuffer

(

)

Close a promise buffer.

Template Parameters

BUF	Represents a class of type Buffer.

Note

Once closed no more Pushes can be made into the buffer. The corresponding future can still Pull values until the buffer is empty.

Returns

0 on success.

getIThreadFuture()

template<template< class > class PROMISE, class T>

virtual ThreadFuturePtr<T> Bloomberg::quantum::IThreadPromise< PROMISE, T >::getIThreadFuture ( ) const

pure virtual

Get the associated thread future.

Returns

An interface to the associated future object sharing a common state.

Implemented in Bloomberg::quantum::Promise< T >.

push()

template<template< class > class PROMISE, class T >

template<class V , class >

void Bloomberg::quantum::IThreadPromise< PROMISE, T >::push

(

V &&

value

)

Push a single value into the promise buffer.

Template Parameters

BUF	Represents a class of type Buffer.
V	The type of value contained in Buffer.

Parameters

[in]

value

Value to push at the end of the buffer.

Note

Method available for buffered futures only. Once the buffer is closed, no more Push operations are allowed.

set()

template<template< class > class PROMISE, class T >

template<class V , class >

int Bloomberg::quantum::IThreadPromise< PROMISE, T >::set

(

V &&

value

)

Set the promised value.

Template Parameters

V	The type of the value. Must be implicitly deduced by the compiler and should always be == T.

Parameters

[in]

value

A reference to the value (l-value or r-value).

Returns

0 on success