CCassQueryList Class Reference

Search Toolkit Book for CCassQueryList

#include <objtools/pubseq_gateway/impl/cassandra/cass_query_list.hpp>

Collaboration diagram for CCassQueryList:

Classes
class	CQryNotification
struct	SPendingSlot
struct	SQrySlot

Public Member Functions
virtual	~CCassQueryList ()
CCassQueryList &	SetMaxQueries (size_t max_queries)
CCassQueryList &	SetKeyspace (const string &keyspace)
CCassQueryList &	SetTickCB (TCassQueryListTickCB cb)
string	GetKeyspace () const
size_t	GetMaxQueries () const
bool	HasError () const
size_t	NumberOfActiveQueries () const
size_t	NumberOfBusySlots () const
size_t	NumberOfPendingSlots () const
string	ToString () const
void	Finalize ()
void	Cancel (const exception *e=nullptr)
void	Cancel (ICassQueryListConsumer *consumer, const exception *e=nullptr)
void	Execute (unique_ptr< ICassQueryListConsumer > consumer, int retry_count, bool post_async=false)
bool	HasEmptySlot ()
void	Yield (bool wait)
shared_ptr< CCassQuery >	Extract (size_t slot_index)

Static Public Member Functions
static shared_ptr< CCassQueryList >	Create (shared_ptr< CCassConnection > cass_conn) noexcept

Static Public Attributes
static constexpr const unsigned int	kDfltMaxQuery = 128
static constexpr const uint64_t	kReadyPushWaitTimeout = 500000
static constexpr const uint64_t	kReadyPopWaitTimeout = 500
static constexpr const size_t	kNotifyQueueLen = 2048
static constexpr const unsigned int	kResetRelaxTime = 10

Protected Member Functions
	CCassQueryList ()

Private Types
enum	SQrySlotState {   ssAvailable , ssAttached , ssReadingRow , ssReseting ,   ssReleasing , ssLast = ssReleasing + 1 }

Private Member Functions
void	Tick ()
SQrySlot *	CheckSlots (bool discard, bool wait=true)
SQrySlot *	CheckSlot (size_t index, bool discard)
void	CheckPending (SQrySlot *slot)
void	AttachSlot (SQrySlot *slot, SPendingSlot &&pending_slot)
void	DetachSlot (SQrySlot *slot)
void	ReadRows (SQrySlot *slot)
void	Release (SQrySlot *slot)
void	CheckAccess ()

Private Attributes
weak_ptr< CCassQueryList >	m_self_weak
shared_ptr< CCassConnection >	m_cass_conn
vector< SQrySlot >	m_query_arr
mpmc_bounded_queue_w< size_t, kNotifyQueueLen >	m_ready
bool	m_has_error
size_t	m_max_queries
vector< SPendingSlot >	m_pending_arr
vector< shared_ptr< CQryNotification > >	m_notification_arr
TCassQueryListTickCB	m_tick_cb
atomic_bool	m_yield_in_progress
string	m_keyspace
atomic_size_t	m_attached_slots
atomic< thread::id >	m_owning_thread

Static Private Attributes
static string	SQrySlotStateStr [ssLast] = {"ssAvailable", "ssAttached", "ssReadingRow", "ssReseting", "ssReleasing"}
	CCassQueryList. More...

Detailed Description

Definition at line 35 of file cass_query_list.hpp.

Member Enumeration Documentation

SQrySlotState

enum CCassQueryList::SQrySlotState

private

Enumerator
ssAvailable
ssAttached
ssReadingRow
ssReseting
ssReleasing
ssLast

Definition at line 72 of file cass_query_list.hpp.

Constructor & Destructor Documentation

~CCassQueryList()

CCassQueryList::~CCassQueryList ( )

virtual

Definition at line 76 of file cass_query_list.cpp.

References Cancel(), ERR_POST, Error(), m_notification_arr, m_pending_arr, m_query_arr, NumberOfActiveQueries(), NumberOfBusySlots(), and NumberOfPendingSlots().

CCassQueryList()

CCassQueryList::CCassQueryList ( )

inlineprotected

Definition at line 64 of file cass_query_list.hpp.

Member Function Documentation

AttachSlot()

void CCassQueryList::AttachSlot ( SQrySlot *  slot, SPendingSlot &&  pending_slot  )

private

Definition at line 238 of file cass_query_list.cpp.

References assert, b, CheckPending(), DetachSlot(), ERR_POST, Info(), m_attached_slots, m_cass_conn, CCassQueryList::SQrySlot::m_consumer, CCassQueryList::SQrySlot::m_index, m_notification_arr, CCassQueryList::SQrySlot::m_qry, CCassQueryList::SQrySlot::m_retry_count, CCassQueryList::SQrySlot::m_state, ssAttached, ssAvailable, and Tick().

Referenced by CheckPending(), and Execute().

Cancel() [1/2]

void CCassQueryList::Cancel

(

const exception *

e = nullptr

)

Definition at line 390 of file cass_query_list.cpp.

References CheckAccess(), DetachSlot(), i, m_has_error, m_pending_arr, m_query_arr, ssAvailable, and Tick().

Referenced by ~CCassQueryList().

Cancel() [2/2]

void CCassQueryList::Cancel	(	ICassQueryListConsumer *	consumer,
		const exception *	e = nullptr
	)

Definition at line 361 of file cass_query_list.cpp.

References CheckAccess(), DetachSlot(), i, m_has_error, m_pending_arr, m_query_arr, ssAvailable, and Tick().

CheckAccess()

void CCassQueryList::CheckAccess ( )

private

Definition at line 157 of file cass_query_list.cpp.

References m_owning_thread, and NCBI_THROW.

Referenced by Cancel(), Execute(), Finalize(), and Yield().

CheckPending()

void CCassQueryList::CheckPending ( SQrySlot *  slot )

private

Definition at line 268 of file cass_query_list.cpp.

References assert, AttachSlot(), m_pending_arr, CCassQueryList::SQrySlot::m_state, and ssAvailable.

Referenced by AttachSlot(), Finalize(), Release(), and Yield().

CheckSlot()

CCassQueryList::SQrySlot * CCassQueryList::CheckSlot ( size_t  index, bool  discard  )

private

Definition at line 468 of file cass_query_list.cpp.

References ar_dataready, ar_done, assert, DetachSlot(), CCassandraException::eQueryFailedRestartable, CCassandraException::eQueryTimeout, ERR_POST, Error(), CException::GetErrCode(), kResetRelaxTime, CCassQueryList::SQrySlot::m_consumer, m_has_error, CCassQueryList::SQrySlot::m_index, CCassQueryList::SQrySlot::m_qry, m_query_arr, CCassQueryList::SQrySlot::m_retry_count, CCassQueryList::SQrySlot::m_state, NCBI_THROW, ReadRows(), Release(), SSignalHandler::s_CtrlCPressed(), ssAttached, ssAvailable, ssReleasing, ssReseting, Warning(), and CException::what().

Referenced by CheckSlots(), and Yield().

CheckSlots()

CCassQueryList::SQrySlot * CCassQueryList::CheckSlots ( bool  discard, bool  wait = true  )

private

Definition at line 437 of file cass_query_list.cpp.

References CheckSlot(), m_query_arr, m_ready, CCassQueryList::SQrySlot::m_state, mpmc_bounded_queue_w< T, SZ >::pop_wait(), ssAvailable, and Yield().

Referenced by Execute(), Finalize(), HasEmptySlot(), and Yield().

Create()

shared_ptr< CCassQueryList > CCassQueryList::Create ( shared_ptr< CCassConnection >  cass_conn )

staticnoexcept

Definition at line 67 of file cass_query_list.cpp.

DetachSlot()

void CCassQueryList::DetachSlot ( SQrySlot *  slot )

private

Definition at line 226 of file cass_query_list.cpp.

References assert, m_attached_slots, CCassQueryList::SQrySlot::m_consumer, CCassQueryList::SQrySlot::m_qry, CCassQueryList::SQrySlot::m_state, and ssAvailable.

Referenced by AttachSlot(), Cancel(), CheckSlot(), and Release().

Execute()

void CCassQueryList::Execute	(	unique_ptr< ICassQueryListConsumer >	consumer,
		int	retry_count,
		bool	post_async = false
	)

Definition at line 166 of file cass_query_list.cpp.

References AttachSlot(), CheckAccess(), CheckSlots(), m_max_queries, m_notification_arr, m_pending_arr, m_query_arr, SetMaxQueries(), ssAvailable, and Tick().

Extract()

shared_ptr< CCassQuery > CCassQueryList::Extract

(

size_t

slot_index

)

Definition at line 350 of file cass_query_list.cpp.

References m_query_arr, and Release().

Finalize()

void CCassQueryList::Finalize

(

void

)

Definition at line 409 of file cass_query_list.cpp.

References CheckAccess(), CheckPending(), CheckSlots(), m_pending_arr, m_query_arr, NCBI_THROW, SSignalHandler::s_CtrlCPressed(), and Tick().

GetKeyspace()

string CCassQueryList::GetKeyspace

(

)

const

Definition at line 104 of file cass_query_list.cpp.

References m_keyspace.

GetMaxQueries()

size_t CCassQueryList::GetMaxQueries

(

)

const

Definition at line 118 of file cass_query_list.cpp.

References m_max_queries.

HasEmptySlot()

bool CCassQueryList::HasEmptySlot

(

)

Definition at line 193 of file cass_query_list.cpp.

References CheckSlots(), and m_query_arr.

HasError()

bool CCassQueryList::HasError

(

)

const

Definition at line 122 of file cass_query_list.cpp.

References m_has_error.

NumberOfActiveQueries()

size_t CCassQueryList::NumberOfActiveQueries

(

)

const

Definition at line 131 of file cass_query_list.cpp.

References m_query_arr, ssAvailable, and ssReleasing.

Referenced by ~CCassQueryList().

NumberOfBusySlots()

size_t CCassQueryList::NumberOfBusySlots

(

)

const

Definition at line 140 of file cass_query_list.cpp.

References m_attached_slots.

Referenced by ~CCassQueryList().

NumberOfPendingSlots()

size_t CCassQueryList::NumberOfPendingSlots

(

)

const

Definition at line 144 of file cass_query_list.cpp.

References m_pending_arr.

Referenced by ~CCassQueryList().

ReadRows()

void CCassQueryList::ReadRows ( SQrySlot *  slot )

private

Definition at line 298 of file cass_query_list.cpp.

References ar_dataready, ar_done, ar_wait, assert, CCassQueryList::SQrySlot::m_consumer, CCassQueryList::SQrySlot::m_index, CCassQueryList::SQrySlot::m_qry, CCassQueryList::SQrySlot::m_state, NCBI_THROW, Release(), ssAttached, ssAvailable, ssReadingRow, and ssReleasing.

Referenced by CheckSlot().

Release()

void CCassQueryList::Release ( SQrySlot *  slot )

private

Definition at line 277 of file cass_query_list.cpp.

References assert, CheckPending(), DetachSlot(), CCassQueryList::SQrySlot::m_consumer, CCassQueryList::SQrySlot::m_index, CCassQueryList::SQrySlot::m_qry, CCassQueryList::SQrySlot::m_state, ssAttached, ssAvailable, and ssReleasing.

Referenced by CheckSlot(), Extract(), and ReadRows().

SetKeyspace()

CCassQueryList & CCassQueryList::SetKeyspace

(

const string &

keyspace

)

Definition at line 108 of file cass_query_list.cpp.

References m_keyspace.

SetMaxQueries()

CCassQueryList & CCassQueryList::SetMaxQueries

(

size_t

max_queries

)

Definition at line 92 of file cass_query_list.cpp.

References m_max_queries, m_notification_arr, and m_self_weak.

Referenced by Execute().

SetTickCB()

CCassQueryList & CCassQueryList::SetTickCB

(

TCassQueryListTickCB

cb

)

Definition at line 113 of file cass_query_list.cpp.

References m_tick_cb.

Tick()

void CCassQueryList::Tick ( )

private

Definition at line 126 of file cass_query_list.cpp.

References m_tick_cb.

Referenced by AttachSlot(), Cancel(), Execute(), and Finalize().

ToString()

string CCassQueryList::ToString

(

void

)

const

Definition at line 148 of file cass_query_list.cpp.

References i, CCassQueryList::SQrySlot::m_qry, m_query_arr, CCassQueryList::SQrySlot::m_state, SQrySlotStateStr, and ssLast.

Yield()

void CCassQueryList::Yield

(

bool

wait

)

Definition at line 200 of file cass_query_list.cpp.

References CheckAccess(), CheckPending(), CheckSlot(), CheckSlots(), expected, kReadyPopWaitTimeout, m_pending_arr, m_ready, m_yield_in_progress, max(), and mpmc_bounded_queue_w< T, SZ >::pop_wait().

Referenced by CheckSlots().

Member Data Documentation

kDfltMaxQuery

constexpr const unsigned int CCassQueryList::kDfltMaxQuery = 128

staticconstexpr

Definition at line 37 of file cass_query_list.hpp.

kNotifyQueueLen

constexpr const size_t CCassQueryList::kNotifyQueueLen = 2048

staticconstexpr

Definition at line 40 of file cass_query_list.hpp.

kReadyPopWaitTimeout

constexpr const uint64_t CCassQueryList::kReadyPopWaitTimeout = 500

staticconstexpr

Definition at line 39 of file cass_query_list.hpp.

Referenced by Yield().

kReadyPushWaitTimeout

constexpr const uint64_t CCassQueryList::kReadyPushWaitTimeout = 500000

staticconstexpr

Definition at line 38 of file cass_query_list.hpp.

Referenced by CCassQueryList::CQryNotification::OnData().

kResetRelaxTime

constexpr const unsigned int CCassQueryList::kResetRelaxTime = 10

staticconstexpr

Definition at line 41 of file cass_query_list.hpp.

Referenced by CheckSlot().

m_attached_slots

atomic_size_t CCassQueryList::m_attached_slots

private

Definition at line 122 of file cass_query_list.hpp.

Referenced by AttachSlot(), DetachSlot(), and NumberOfBusySlots().

m_cass_conn

shared_ptr<CCassConnection> CCassQueryList::m_cass_conn

private

Definition at line 112 of file cass_query_list.hpp.

Referenced by AttachSlot().

m_has_error

bool CCassQueryList::m_has_error

private

Definition at line 115 of file cass_query_list.hpp.

Referenced by Cancel(), CheckSlot(), and HasError().

m_keyspace

string CCassQueryList::m_keyspace

private

Definition at line 121 of file cass_query_list.hpp.

Referenced by GetKeyspace(), and SetKeyspace().

m_max_queries

size_t CCassQueryList::m_max_queries

private

Definition at line 116 of file cass_query_list.hpp.

Referenced by Execute(), GetMaxQueries(), and SetMaxQueries().

m_notification_arr

vector<shared_ptr<CQryNotification> > CCassQueryList::m_notification_arr

private

Definition at line 118 of file cass_query_list.hpp.

Referenced by AttachSlot(), Execute(), SetMaxQueries(), and ~CCassQueryList().

m_owning_thread

atomic<thread::id> CCassQueryList::m_owning_thread

private

Definition at line 123 of file cass_query_list.hpp.

Referenced by CheckAccess().

m_pending_arr

vector<SPendingSlot> CCassQueryList::m_pending_arr

private

Definition at line 117 of file cass_query_list.hpp.

Referenced by Cancel(), CheckPending(), Execute(), Finalize(), NumberOfPendingSlots(), Yield(), and ~CCassQueryList().

m_query_arr

vector<SQrySlot> CCassQueryList::m_query_arr

private

Definition at line 113 of file cass_query_list.hpp.

Referenced by Cancel(), CheckSlot(), CheckSlots(), Execute(), Extract(), Finalize(), HasEmptySlot(), NumberOfActiveQueries(), ToString(), and ~CCassQueryList().

m_ready

mpmc_bounded_queue_w<size_t, kNotifyQueueLen> CCassQueryList::m_ready

private

Definition at line 114 of file cass_query_list.hpp.

Referenced by CheckSlots(), and Yield().

m_self_weak

weak_ptr<CCassQueryList> CCassQueryList::m_self_weak

private

Definition at line 111 of file cass_query_list.hpp.

Referenced by SetMaxQueries().

m_tick_cb

TCassQueryListTickCB CCassQueryList::m_tick_cb

private

Definition at line 119 of file cass_query_list.hpp.

Referenced by SetTickCB(), and Tick().

m_yield_in_progress

atomic_bool CCassQueryList::m_yield_in_progress

private

Definition at line 120 of file cass_query_list.hpp.

Referenced by Yield().

SQrySlotStateStr

string CCassQueryList::SQrySlotStateStr = {"ssAvailable", "ssAttached", "ssReadingRow", "ssReseting", "ssReleasing"}

staticprivate

CCassQueryList.

Definition at line 80 of file cass_query_list.hpp.

Referenced by ToString().

---

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

• include/objtools/pubseq_gateway/impl/cassandra/cass_query_list.hpp
• src/objtools/pubseq_gateway/cassandra/cass_query_list.cpp