Bloomberg::quantum::IQueue Interface Reference

Interface to a task queue. For internal use only. More...

#include <quantum_iqueue.h>

Inheritance diagram for Bloomberg::quantum::IQueue:

Public Types
enum	QueueType : int { QueueType::Coro, QueueType::IO, QueueType::All }
enum	QueueId : int { QueueId::Any = -1, QueueId::Same = -2, QueueId::All = -3 }
using	Ptr = std::shared_ptr< IQueue >

Public Member Functions
virtual void	pinToCore (int coreId)=0
virtual void	run ()=0
virtual void	enqueue (ITask::Ptr task)=0
virtual bool	tryEnqueue (ITask::Ptr task)=0
virtual ITask::Ptr	dequeue (std::atomic_bool &hint)=0
virtual ITask::Ptr	tryDequeue (std::atomic_bool &hint)=0
virtual size_t	size () const =0
virtual bool	empty () const =0
virtual IQueueStatistics &	stats ()=0
virtual SpinLock &	getLock ()=0
virtual void	signalEmptyCondition (bool value)=0
virtual bool	isIdle () const =0
Public Member Functions inherited from Bloomberg::quantum::ITerminate
virtual	~ITerminate ()=default
	Virtual destructor. This function is explicitly left empty. More...
virtual void	terminate ()=0
	Terminates the object. More...

Detailed Description

Interface to a task queue. For internal use only.

Member Typedef Documentation

Ptr

using Bloomberg::quantum::IQueue::Ptr = std::shared_ptr<IQueue>

Member Enumeration Documentation

QueueId

enum Bloomberg::quantum::IQueue::QueueId : int

strong

Enumerator
Any
Same
All

QueueType

enum Bloomberg::quantum::IQueue::QueueType : int

strong

Enumerator
Coro
IO
All

Member Function Documentation

dequeue()

virtual ITask::Ptr Bloomberg::quantum::IQueue::dequeue ( std::atomic_bool &  hint )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

empty()

virtual bool Bloomberg::quantum::IQueue::empty ( ) const

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

enqueue()

virtual void Bloomberg::quantum::IQueue::enqueue ( ITask::Ptr  task )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

getLock()

virtual SpinLock& Bloomberg::quantum::IQueue::getLock ( )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

isIdle()

virtual bool Bloomberg::quantum::IQueue::isIdle ( ) const

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

pinToCore()

virtual void Bloomberg::quantum::IQueue::pinToCore ( int  coreId )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

run()

virtual void Bloomberg::quantum::IQueue::run ( )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

signalEmptyCondition()

virtual void Bloomberg::quantum::IQueue::signalEmptyCondition ( bool  value )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

size()

virtual size_t Bloomberg::quantum::IQueue::size ( ) const

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

stats()

virtual IQueueStatistics& Bloomberg::quantum::IQueue::stats ( )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

tryDequeue()

virtual ITask::Ptr Bloomberg::quantum::IQueue::tryDequeue ( std::atomic_bool &  hint )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.

tryEnqueue()

virtual bool Bloomberg::quantum::IQueue::tryEnqueue ( ITask::Ptr  task )

pure virtual

Implemented in Bloomberg::quantum::TaskQueue, and Bloomberg::quantum::IoQueue.