#include <Inquirer.h>

Inheritance diagram for Ipc::Inquirer:
Collaboration diagram for Ipc::Inquirer:

Public Types

typedef CbcPointer< AsyncJobPointer

Public Member Functions

 Inquirer (Request::Pointer aRequest, const Ipc::StrandCoords &coords, double aTimeout)
virtual ~Inquirer ()
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
void callStart (AsyncCall &call)
virtual void callEnd ()
 called right after the called job method More...
void handleStopRequest ()
 process external request to terminate now (i.e. during this async call) More...
virtual void * toCbdata ()=0

Static Public Member Functions

static void HandleRemoteAck (const Response &response)
 finds and calls the right Inquirer upon strand's response More...
static void Start (const Pointer &job)

Public Attributes

CodeContextPointer codeContext
const InstanceId< AsyncJobid
 job identifier More...

Protected Types

typedef std::map< RequestId::Index, AsyncCall::PointerRequestsMap
 maps request->id to Inquirer::handleRemoteAck callback More...

Protected Member Functions

virtual void start ()
 called by AsyncStart; do not call directly More...
virtual void swanSong ()
virtual bool doneAll () const
 whether positive goal has been reached More...
virtual const char * status () const
 internal cleanup; do not call directly More...
virtual void inquire ()
 inquire the next strand More...
virtual void cleanup ()
 perform cleanup actions on completion of job More...
virtual void handleException (const std::exception &e)
 do specific exception handling More...
virtual void sendResponse ()=0
 send response to client More...
virtual bool aggregate (Response::Pointer aResponse)=0
 perform aggregating of responses and returns true if need to continue More...
void deleteThis (const char *aReason)
void mustStop (const char *aReason)
bool done () const
 the job is destroyed in callEnd() when done() More...

Protected Attributes

Request::Pointer request
 cache manager request received from client More...
Ipc::StrandCoords strands
 all strands we want to query, in order More...
Ipc::StrandCoords::const_iterator pos
 strand we should query now More...
const double timeout
 number of seconds to wait for strand response More...
const char * stopReason
 reason for forcing done() to be true More...
const char * typeName
 kid (leaf) class name, for debugging More...
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
bool started_ = false
 Start() has finished successfully. More...
bool swanSang_ = false
 swanSong() was called More...

Static Protected Attributes

static RequestsMap TheRequestsMap
 pending strand requests More...
static RequestId::Index LastRequestId = 0
 last requestId used More...

Private Types

typedef UnaryMemFunT< Inquirer, Response::Pointer, Response::PointerHandleAckDialer

Private Member Functions

 CBDATA_CLASS (Inquirer)
void handleRemoteAck (Response::Pointer response)
 called when a strand is done writing its output More...
void requestTimedOut ()
 called when the strand failed to respond (or finish responding) in time More...
void removeTimeoutEvent ()
 called when we are no longer waiting for the strand to respond More...

Static Private Member Functions

static AsyncCall::Pointer DequeueRequest (RequestId::Index)
 returns and forgets the right Inquirer callback for strand request More...
static void RequestTimedOut (void *param)
 Ipc::Inquirer::requestTimedOut wrapper. More...

Detailed Description

Coordinator's job that sends a cache manage request to each strand, aggregating individual strand responses and dumping the result if needed

Definition at line 28 of file Inquirer.h.

Member Typedef Documentation

◆ HandleAckDialer

◆ Pointer

Definition at line 34 of file AsyncJob.h.

◆ RequestsMap

Definition at line 82 of file Inquirer.h.

Constructor & Destructor Documentation

◆ Inquirer()

Ipc::Inquirer::Inquirer ( Request::Pointer  aRequest,
const Ipc::StrandCoords coords,
double  aTimeout 

Definition at line 33 of file Inquirer.cc.

References debugs, LesserStrandByKidId(), MYNAME, and strands.

◆ ~Inquirer()

Ipc::Inquirer::~Inquirer ( )

Definition at line 45 of file Inquirer.cc.

References debugs, and MYNAME.

Member Function Documentation

◆ aggregate()

virtual bool Ipc::Inquirer::aggregate ( Response::Pointer  aResponse)
protectedpure virtual

Implemented in Snmp::Inquirer, and Mgr::Inquirer.

◆ callEnd()

void AsyncJob::callEnd ( )

◆ callException()

void Ipc::Inquirer::callException ( const std::exception &  e)

Reimplemented from AsyncJob.

Definition at line 129 of file Inquirer.cc.

References AsyncJob::callException(), DBG_CRITICAL, debugs, and MYNAME.

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 102 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, AsyncJob::inCall, and NULL.


Ipc::Inquirer::CBDATA_CLASS ( Inquirer  )

◆ cleanup()

void Ipc::Inquirer::cleanup ( )

Reimplemented in Snmp::Inquirer, and Mgr::Inquirer.

Definition at line 52 of file Inquirer.cc.

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ DequeueRequest()

AsyncCall::Pointer Ipc::Inquirer::DequeueRequest ( RequestId::Index  requestId)

Definition at line 142 of file Inquirer.cc.

References debugs, Must, NULL, and request().

◆ done()

bool AsyncJob::done ( ) const

◆ doneAll()

bool Ipc::Inquirer::doneAll ( ) const

Reimplemented from AsyncJob.

Reimplemented in Snmp::Inquirer, and Mgr::Inquirer.

Definition at line 116 of file Inquirer.cc.

Referenced by Mgr::Inquirer::doneAll(), and Snmp::Inquirer::doneAll().

◆ handleException()

void Ipc::Inquirer::handleException ( const std::exception &  e)

Reimplemented in Snmp::Inquirer.

Definition at line 122 of file Inquirer.cc.

References debugs.

Referenced by Snmp::Inquirer::handleException().

◆ HandleRemoteAck()

◆ handleRemoteAck()

void Ipc::Inquirer::handleRemoteAck ( Response::Pointer  response)

Definition at line 88 of file Inquirer.cc.

References debugs, Must, and request().

Referenced by inquire().

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ inquire()

void Ipc::Inquirer::inquire ( )

◆ mustStop()

◆ removeTimeoutEvent()

void Ipc::Inquirer::removeTimeoutEvent ( )

Definition at line 171 of file Inquirer.cc.

References eventDelete(), eventFind(), and RequestTimedOut().

◆ requestTimedOut()

void Ipc::Inquirer::requestTimedOut ( )

Definition at line 192 of file Inquirer.cc.

References debugs, Must, MYNAME, and request().

◆ RequestTimedOut()

void Ipc::Inquirer::RequestTimedOut ( void *  param)

Definition at line 179 of file Inquirer.cc.

References CallBack(), codeContext, debugs, Must, MYNAME, and NULL.

Referenced by inquire(), and removeTimeoutEvent().

◆ sendResponse()

virtual void Ipc::Inquirer::sendResponse ( )
protectedpure virtual

Implemented in Snmp::Inquirer, and Mgr::Inquirer.

◆ start()

void Ipc::Inquirer::start ( )

Reimplemented from AsyncJob.

Reimplemented in Snmp::Inquirer, and Mgr::Inquirer.

Definition at line 57 of file Inquirer.cc.

References request().

Referenced by Mgr::Inquirer::start(), and Snmp::Inquirer::start().

◆ Start()

◆ status()

const char * Ipc::Inquirer::status ( ) const

for debugging, starts with space

Reimplemented from AsyncJob.

Definition at line 205 of file Inquirer.cc.

References Packable::appendf(), MemBuf::content(), request(), MemBuf::reset(), and MemBuf::terminate().

◆ swanSong()

void Ipc::Inquirer::swanSong ( )

Reimplemented from AsyncJob.

Definition at line 103 of file Inquirer.cc.

References debugs, MYNAME, and request().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ codeContext

CodeContextPointer Ipc::Inquirer::codeContext

Definition at line 42 of file Inquirer.h.

Referenced by RequestTimedOut().

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 73 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

◆ LastRequestId

Ipc::RequestId::Index Ipc::Inquirer::LastRequestId = 0

Definition at line 85 of file Inquirer.h.

◆ pos

Ipc::StrandCoords::const_iterator Ipc::Inquirer::pos

Definition at line 77 of file Inquirer.h.

◆ request

Request::Pointer Ipc::Inquirer::request

Definition at line 74 of file Inquirer.h.

Referenced by Snmp::Inquirer::Inquirer().

◆ started_

bool AsyncJob::started_ = false

Definition at line 83 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason

◆ strands

Ipc::StrandCoords Ipc::Inquirer::strands

Definition at line 76 of file Inquirer.h.

Referenced by Inquirer().

◆ swanSang_

bool AsyncJob::swanSang_ = false

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ TheRequestsMap

Ipc::Inquirer::RequestsMap Ipc::Inquirer::TheRequestsMap

Definition at line 83 of file Inquirer.h.

◆ timeout

const double Ipc::Inquirer::timeout

Definition at line 79 of file Inquirer.h.

◆ typeName

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






Web Site Translations