Ipc::Coordinator Class Reference

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< AsyncJob >	Pointer

Public Member Functions
	Coordinator ()
void	broadcastSignal (int sig) const
	send sig to registered strands More...
const StrandCoords &	strands () 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...
virtual void *	toCbdata ()=0

Static Public Member Functions
static Coordinator *	Instance ()
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 Pointer	Start (AsyncJob *job)
	starts a freshly created job (i.e., makes the job asynchronous) More...

Public Attributes
struct sockaddr_un	address
	UDS address from path; treat as read-only. More...

Protected Member Functions
virtual void	start ()
	called by AsyncStart; do not call directly More...
virtual void	receive (const TypedMsgHdr &message)
	handle IPC message just read More...
StrandCoord *	findStrand (int kidId)
	registered strand or NULL More...
void	registerStrand (const StrandCoord &)
	adds or updates existing More...
void	handleRegistrationRequest (const HereIamMessage &)
	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...
virtual bool	doneAll () const
	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::ConnectionPointer &	conn ()
	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...

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...
const InstanceId< AsyncJob >	id
	job identifier More...

Private Types
typedef std::list < StrandSearchRequest >	Searchers
	search requests More...
typedef std::map < OpenListenerParams, Comm::ConnectionPointer >	Listeners
	params:connection map More...

Private Member Functions
	CBDATA_CLASS (Coordinator)
	Coordinator (const Coordinator &)
Coordinator &	operator= (const Coordinator &)

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

Static Private Attributes
static Coordinator *	TheInstance = NULL
	the only class instance in existence More...

Detailed Description

Definition at line 30 of file Coordinator.h.

Member Typedef Documentation

typedef std::map<OpenListenerParams, Comm::ConnectionPointer> Ipc::Coordinator::Listeners

private

Definition at line 74 of file Coordinator.h.

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

typedef std::list<StrandSearchRequest> Ipc::Coordinator::Searchers

private

Definition at line 71 of file Coordinator.h.

Constructor & Destructor Documentation

Ipc::Coordinator::Coordinator

(

)

Definition at line 34 of file Coordinator.cc.

Ipc::Coordinator::Coordinator ( const Coordinator &  )

private

Member Function Documentation

void Ipc::Coordinator::broadcastSignal

(

int

sig

)

const

Definition at line 281 of file Coordinator.cc.

References debugs, and HERE().

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 136 of file AsyncJob.cc.

References AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), HERE(), AsyncJob::inCall, NULL, AsyncJob::status(), AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

void AsyncJob::callException ( const std::exception &  e )

virtualinherited

Reimplemented in Adaptation::Icap::ModXact, ClientHttpRequest, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, Ftp::Server, Ipc::Forwarder, and Ipc::Inquirer.

Definition at line 127 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by Ipc::Inquirer::callException(), Ipc::Forwarder::callException(), Ftp::Server::callException(), and Adaptation::Icap::Xaction::callException().

void AsyncJob::callStart ( AsyncCall &  call )

inherited

called just before the called method

Definition at line 114 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

bool AsyncJob::canBeCalled ( AsyncCall &  call ) const

inherited

Definition at line 101 of file AsyncJob.cc.

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

Ipc::Coordinator::CBDATA_CLASS ( Coordinator  )

private

void Ipc::UdsOp::clearTimeout ( )

protectedinherited

Definition at line 62 of file UdsOp.cc.

References commUnsetConnTimeout(), and conn.

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

protectedinherited

Definition at line 41 of file UdsOp.cc.

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

String Ipc::Port::CoordinatorAddr ( )

staticinherited

Definition at line 64 of file Port.cc.

References String::append(), SBuf::c_str(), channelPathPfx, coordinatorAddrLabel, service_name, and String::size().

Referenced by IpcIoFile::open(), Ipc::Strand::registerSelf(), Snmp::SendResponse(), Mgr::Action::sendResponse(), SendSharedListenRequest(), and Ipc::Forwarder::start().

void AsyncJob::deleteThis ( const char *  aReason )

protectedinherited

Definition at line 49 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed().

void Ipc::Port::doListen ( )

protectedinherited

Definition at line 36 of file Port.cc.

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

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 90 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), and Downloader::downloadFinished().

bool Ipc::Port::doneAll ( ) const

protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 46 of file Port.cc.

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

protected

Definition at line 44 of file Coordinator.cc.

References NULL.

void Ipc::Coordinator::handleCacheMgrRequest ( const Mgr::Request &  request )

protected

Definition at line 167 of file Coordinator.cc.

References action(), Mgr::ActionParams::actionName, Mgr::Request::conn, CacheManager::createRequestedAction(), DBG_IMPORTANT, debugs, Comm::Connection::fd, CacheManager::GetInstance(), HERE(), Mgr::Response::pack(), Mgr::Request::params, Ipc::Request::requestId, Ipc::Request::requestorId, Ipc::SendMessage(), AsyncJob::Start(), and Ipc::strandAddrLabel.

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

protected

Definition at line 193 of file Coordinator.cc.

References Ipc::Inquirer::HandleRemoteAck().

void Ipc::Coordinator::handleRegistrationRequest ( const HereIamMessage &  msg )

protected

Definition at line 136 of file Coordinator.cc.

References Ipc::StrandCoord::kidId, Ipc::HereIamMessage::pack(), Ipc::SendMessage(), Ipc::HereIamMessage::strand, and Ipc::strandAddrLabel.

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

protected

Definition at line 199 of file Coordinator.cc.

References debugs, HERE(), i, NULL, Ipc::StrandSearchRequest::requestorId, and Ipc::StrandSearchRequest::tag.

void Ipc::Coordinator::handleSharedListenRequest ( const SharedListenRequest &  request )

protected

Definition at line 147 of file Coordinator.cc.

References Ipc::OpenListenerParams::addr, debugs, Comm::Connection::fd, HERE(), i, Ipc::SharedListenRequest::mapId, Ipc::SharedListenResponse::pack(), Ipc::SharedListenRequest::params, Ipc::SharedListenRequest::requestorId, Ipc::SendMessage(), and Ipc::strandAddrLabel.

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

protected

Definition at line 233 of file Coordinator.cc.

References debugs, HERE(), Snmp::Response::pack(), Ipc::Request::requestId, Ipc::Request::requestorId, Ipc::SendMessage(), AsyncJob::Start(), and Ipc::strandAddrLabel.

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

protected

Definition at line 246 of file Coordinator.cc.

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

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

static

Definition at line 291 of file Coordinator.cc.

Referenced by SquidMain().

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

staticinherited

Definition at line 51 of file Port.cc.

References addr, String::append(), assert, SBuf::c_str(), channelPathPfx, service_name, and xitoa().

Referenced by Ipc::Inquirer::inquire(), CollapsedForwarding::Notify(), and IpcIoFile::Notify().

void AsyncJob::mustStop ( const char *  aReason )

protectedinherited

Definition at line 69 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

void Ipc::Coordinator::notifySearcher ( const StrandSearchRequest &  request, const StrandCoord &  strand  )

protected

Definition at line 220 of file Coordinator.cc.

References debugs, HERE(), Ipc::StrandCoord::kidId, Ipc::StrandSearchResponse::pack(), Ipc::StrandSearchRequest::requestorId, Ipc::SendMessage(), Ipc::strandAddrLabel, and Ipc::StrandSearchRequest::tag.

Comm::ConnectionPointer Ipc::Coordinator::openListenSocket ( const SharedListenRequest &  request, int &  errNo  )

protected

Definition at line 254 of file Coordinator.cc.

References Ipc::OpenListenerParams::addr, comm_open_listener(), debugs, enter_suid(), Ipc::FdNote(), Ipc::OpenListenerParams::fdNote, Ipc::OpenListenerParams::flags, Comm::Connection::flags, HERE(), Comm::IsConnOpen(), leave_suid(), Comm::Connection::local, p, Ipc::SharedListenRequest::params, Ipc::OpenListenerParams::proto, Ipc::SharedListenRequest::requestorId, and Ipc::OpenListenerParams::sock_type.

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

private

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

protectedvirtual

Implements Ipc::Port.

Definition at line 79 of file Coordinator.cc.

References DBG_IMPORTANT, debugs, HERE(), Ipc::mtCacheMgrRequest, Ipc::mtCacheMgrResponse, Ipc::mtRegistration, Ipc::mtSharedListenRequest, Ipc::mtSnmpRequest, Ipc::mtSnmpResponse, Ipc::mtStrandSearchRequest, Ipc::StrandSearchRequest::requestorId, Ipc::StrandSearchRequest::tag, and Ipc::TypedMsgHdr::type().

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

protected

Definition at line 54 of file Coordinator.cc.

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

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

protectedinherited

Definition at line 35 of file UdsOp.cc.

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

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

protectedinherited

Definition at line 54 of file UdsOp.cc.

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

AsyncJob::Pointer AsyncJob::Start ( AsyncJob *  job )

staticinherited

Definition at line 23 of file AsyncJob.cc.

References CallJobHere, and AsyncJob::start().

Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), FwdState::connectDone(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::Start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

void Ipc::Coordinator::start ( )

protectedvirtual

Implements Ipc::Port.

Definition at line 39 of file Coordinator.cc.

References Ipc::Port::start().

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Adaptation::Initiate, Comm::TcpAcceptor, and Ipc::Inquirer.

Definition at line 159 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), NULL, MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Comm::TcpAcceptor::status(), and Adaptation::Initiate::status().

const Ipc::StrandCoords & Ipc::Coordinator::strands

(

)

const

Definition at line 302 of file Coordinator.cc.

virtual void AsyncJob::swanSong ( )

inlineprotectedvirtualinherited

Reimplemented in Adaptation::Icap::ModXactLauncher, Adaptation::Icap::ModXact, ConnStateData, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Client, Ipc::UdsSender, Adaptation::Icap::Launcher, Ftp::Relay, Log::TcpLogger, Adaptation::Iterator, Downloader, Comm::TcpAcceptor, Adaptation::Initiate, Ipc::Forwarder, Adaptation::Icap::OptXact, Comm::ConnOpener, Rock::HeaderUpdater, Ipc::Inquirer, Mgr::Forwarder, Rock::Rebuild, Mgr::StoreToCommWriter, PeerPoolMgr, Server, Snmp::Forwarder, and Mgr::Filler.

Definition at line 54 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), PeerPoolMgr::swanSong(), Server::swanSong(), Rock::HeaderUpdater::swanSong(), Comm::ConnOpener::swanSong(), Comm::TcpAcceptor::swanSong(), Log::TcpLogger::swanSong(), Ipc::UdsSender::swanSong(), Client::swanSong(), and Security::PeerConnector::swanSong().

virtual void Ipc::UdsOp::timedout ( )

inlineprotectedvirtualinherited

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

Definition at line 39 of file UdsOp.h.

virtual void* CbdataParent::toCbdata ( )

pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

Member Data Documentation

struct sockaddr_un Ipc::UdsOp::address

inherited

Definition at line 36 of file UdsOp.h.

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

const InstanceId<AsyncJob> AsyncJob::id

protectedinherited

Definition at line 72 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 71 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

Listeners Ipc::Coordinator::listeners

private

Definition at line 75 of file Coordinator.h.

Searchers Ipc::Coordinator::searchers

private

Definition at line 72 of file Coordinator.h.

const char* AsyncJob::stopReason

protectedinherited

Definition at line 69 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), and AsyncJob::status().

StrandCoords Ipc::Coordinator::strands_

private

Definition at line 69 of file Coordinator.h.

Ipc::Coordinator * Ipc::Coordinator::TheInstance = NULL

staticprivate

Definition at line 77 of file Coordinator.h.

const char* AsyncJob::typeName

protectedinherited

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), AsyncJob::mustStop(), Adaptation::Icap::Xaction::Xaction(), and AsyncJob::~AsyncJob().

---

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

• src/ipc/Coordinator.h
• src/ipc/Coordinator.cc