Coordinates shared activities of Strands (Squid processes or threads) More...

#include <Coordinator.h>

Inheritance diagram for Ipc::Coordinator:
Collaboration diagram for Ipc::Coordinator:

Public Types

typedef CbcPointer< AsyncJobPointer

Public Member Functions

 Coordinator ()
void broadcastSignal (int sig) const
 send sig to registered strands More...
const StrandCoordsstrands () const
 currently registered strands 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...
virtual void callException (const std::exception &e)
 called when the job throws during an async call 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 CoordinatorInstance ()
static String MakeAddr (const char *proccessLabel, int id)
 calculates IPC message address for strand id of processLabel type More...
static String CoordinatorAddr ()
 get the IPC message address for coordinator process More...
static void Start (const Pointer &job)
static void RegisterWithCacheManager ()

Public Attributes

struct sockaddr_un address
 UDS address from path; treat as read-only. More...
const InstanceId< AsyncJobid
 job identifier More...

Protected Member Functions

void start () override
 called by AsyncStart; do not call directly More...
void receive (const TypedMsgHdr &message) override
StrandCoordfindStrand (int kidId)
 registered strand or NULL More...
void registerStrand (const StrandCoord &)
 adds or updates existing More...
void handleRegistrationRequest (const StrandMessage &)
 register,ACK More...
void notifySearcher (const StrandSearchRequest &request, const StrandCoord &)
 answer the waiting search request More...
void handleSearchRequest (const StrandSearchRequest &request)
 answers or queues the request if the answer is not yet known More...
void handleSharedListenRequest (const SharedListenRequest &request)
 returns cached socket or calls openListenSocket() More...
void handleCacheMgrRequest (const Mgr::Request &request)
void handleCacheMgrResponse (const Mgr::Response &response)
void handleSnmpRequest (const Snmp::Request &request)
void handleSnmpResponse (const Snmp::Response &response)
Comm::ConnectionPointer openListenSocket (const SharedListenRequest &request, int &errNo)
 calls comm_open_listener() More...
bool doneAll () const override
 whether positive goal has been reached More...
void doListen ()
 read the next incoming message More...
virtual void timedout ()
 called after setTimeout() if timed out More...
Comm::ConnectionPointerconn ()
 creates if needed and returns raw UDS socket descriptor More...
void setTimeout (int seconds, const char *handlerName)
 call timedout() if no UDS messages in a given number of seconds More...
void clearTimeout ()
 remove previously set timeout, if any More...
void setOptions (int newOptions)
 changes socket options More...
void deleteThis (const char *aReason)
void mustStop (const char *aReason)
bool done () const
 the job is destroyed in callEnd() when done() More...
virtual void swanSong ()
virtual const char * status () const
 internal cleanup; do not call directly More...

Static Protected Member Functions

static void ReportAllJobs (StoreEntry *)
 writes a cache manager report about all jobs existing in this worker More...

Protected Attributes

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...

Private Types

typedef std::list< StrandSearchRequestSearchers
 search requests More...
typedef std::map< OpenListenerParams, Comm::ConnectionPointerListeners
 params:connection map More...

Private Member Functions

 CBDATA_CHILD (Coordinator)
 Coordinator (const Coordinator &)
Coordinatoroperator= (const Coordinator &)
void noteRead (const CommIoCbParams &params)
void receiveOrIgnore (const TypedMsgHdr &)
 receive() but ignore any errors More...
void noteTimeout (const CommTimeoutCbParams &p)
 Comm timeout callback; calls timedout() More...
virtual void finalizedInCbdataChild ()=0
 hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

Private Attributes

StrandCoords strands_
 registered processes and threads More...
Searchers searchers
 yet unanswered search requests in arrival order More...
Listeners listeners
 cached comm_open_listener() results More...
TypedMsgHdr buf
 msghdr struct filled by Comm More...
int options
 UDS options. More...
Comm::ConnectionPointer conn_
 UDS descriptor. More...

Static Private Attributes

static CoordinatorTheInstance = nullptr
 the only class instance in existence More...

Detailed Description

Definition at line 30 of file Coordinator.h.

Member Typedef Documentation

◆ Listeners

Definition at line 74 of file Coordinator.h.

◆ Pointer

Definition at line 34 of file AsyncJob.h.

◆ Searchers

Definition at line 71 of file Coordinator.h.

Constructor & Destructor Documentation

◆ Coordinator() [1/2]

Ipc::Coordinator::Coordinator ( )

Definition at line 34 of file

◆ Coordinator() [2/2]

Ipc::Coordinator::Coordinator ( const Coordinator )

Member Function Documentation

◆ broadcastSignal()

void Ipc::Coordinator::broadcastSignal ( int  sig) const

Definition at line 281 of file

References debugs.

◆ callEnd()

void AsyncJob::callEnd ( )

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 117 of file

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


Ipc::Coordinator::CBDATA_CHILD ( Coordinator  )

◆ clearTimeout()

void Ipc::UdsOp::clearTimeout ( )

Definition at line 62 of file

References commUnsetConnTimeout(), and conn.

◆ conn()

Comm::ConnectionPointer & Ipc::UdsOp::conn ( )

Definition at line 41 of file

References COMM_DOBIND, comm_open_uds(), Comm::IsConnOpen(), and Must.

◆ CoordinatorAddr()

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ doListen()

void Ipc::Port::doListen ( )

Definition at line 37 of file

References comm_read(), conn, debugs, JobCallback, MYNAME, and Ipc::Port::noteRead().

◆ done()

bool AsyncJob::done ( ) const

◆ doneAll()

bool Ipc::Port::doneAll ( ) const

Reimplemented from AsyncJob.

Definition at line 47 of file

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )
privatepure virtualinherited

◆ findStrand()

Ipc::StrandCoord * Ipc::Coordinator::findStrand ( int  kidId)

Definition at line 44 of file

◆ handleCacheMgrRequest()

◆ handleCacheMgrResponse()

void Ipc::Coordinator::handleCacheMgrResponse ( const Mgr::Response response)

Definition at line 193 of file

References Ipc::Inquirer::HandleRemoteAck().

◆ handleRegistrationRequest()

void Ipc::Coordinator::handleRegistrationRequest ( const StrandMessage msg)

◆ handleSearchRequest()

void Ipc::Coordinator::handleSearchRequest ( const StrandSearchRequest request)

◆ handleSharedListenRequest()

◆ handleSnmpRequest()

void Ipc::Coordinator::handleSnmpRequest ( const Snmp::Request request)

◆ handleSnmpResponse()

void Ipc::Coordinator::handleSnmpResponse ( const Snmp::Response response)

Definition at line 246 of file

References debugs, Ipc::Inquirer::HandleRemoteAck(), and MYNAME.

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ Instance()

Ipc::Coordinator * Ipc::Coordinator::Instance ( )

Definition at line 291 of file

Referenced by SquidMain().

◆ MakeAddr()

String Ipc::Port::MakeAddr ( const char *  proccessLabel,
int  id 

◆ mustStop()

◆ noteRead()

void Ipc::Port::noteRead ( const CommIoCbParams params)

◆ noteTimeout()

void Ipc::UdsOp::noteTimeout ( const CommTimeoutCbParams p)

Definition at line 67 of file

Referenced by Ipc::UdsOp::setTimeout().

◆ notifySearcher()

◆ openListenSocket()

◆ operator=()

Coordinator & Ipc::Coordinator::operator= ( const Coordinator )

◆ receive()

void Ipc::Coordinator::receive ( const TypedMsgHdr message)

◆ receiveOrIgnore()

void Ipc::Port::receiveOrIgnore ( const TypedMsgHdr message)

◆ registerStrand()

void Ipc::Coordinator::registerStrand ( const StrandCoord strand)

Definition at line 54 of file

References debugs, Ipc::StrandCoord::kidId, String::size(), and Ipc::StrandCoord::tag.

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

Definition at line 215 of file

References Mgr::RegisterAction(), and AsyncJob::ReportAllJobs().

Referenced by mainInitialize().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry e)

Definition at line 198 of file

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ setOptions()

void Ipc::UdsOp::setOptions ( int  newOptions)

Definition at line 35 of file

Referenced by Ipc::Port::Port().

◆ setTimeout()

void Ipc::UdsOp::setTimeout ( int  seconds,
const char *  handlerName 

Definition at line 54 of file

References asyncCall(), commSetConnTimeout(), conn, handler(), and Ipc::UdsOp::noteTimeout().

◆ start()

void Ipc::Coordinator::start ( )

Implements Ipc::Port.

Definition at line 39 of file

References Ipc::Port::start().

◆ Start()

void AsyncJob::Start ( const Pointer job)

◆ status()

◆ strands()

const Ipc::StrandCoords & Ipc::Coordinator::strands ( ) const

Definition at line 302 of file

◆ swanSong()

◆ timedout()

virtual void Ipc::UdsOp::timedout ( )

Reimplemented in Ipc::Strand, and Ipc::UdsSender.

Definition at line 40 of file UdsOp.h.

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ address

struct sockaddr_un Ipc::UdsOp::address

Definition at line 37 of file UdsOp.h.

Referenced by Ipc::UdsSender::UdsSender().

◆ buf

TypedMsgHdr Ipc::Port::buf

Definition at line 47 of file Port.h.

◆ conn_

Comm::ConnectionPointer Ipc::UdsOp::conn_

Definition at line 56 of file UdsOp.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 75 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

◆ listeners

Listeners Ipc::Coordinator::listeners

Definition at line 75 of file Coordinator.h.

◆ options

int Ipc::UdsOp::options

Definition at line 55 of file UdsOp.h.

◆ searchers

Searchers Ipc::Coordinator::searchers

Definition at line 72 of file Coordinator.h.

◆ started_

bool AsyncJob::started_ = false

Definition at line 88 of file AsyncJob.h.

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

◆ stopReason

const char* AsyncJob::stopReason

◆ strands_

StrandCoords Ipc::Coordinator::strands_

Definition at line 69 of file Coordinator.h.

◆ swanSang_

bool AsyncJob::swanSang_ = false

Definition at line 89 of file AsyncJob.h.

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

◆ TheInstance

Ipc::Coordinator * Ipc::Coordinator::TheInstance = nullptr

Definition at line 77 of file Coordinator.h.

◆ typeName

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






Web Site Translations