Receives coordination messages on behalf of its process or thread. More...

#include <Strand.h>

Inheritance diagram for Ipc::Strand:
Collaboration diagram for Ipc::Strand:

Public Types

typedef CbcPointer< AsyncJobPointer

Public Member Functions

 Strand ()
virtual void start ()
 called by AsyncStart; do not call directly 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 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 timedout ()
 called after setTimeout() if timed out More...
virtual void receive (const TypedMsgHdr &message)
 handle IPC message just
virtual bool doneAll () const
 whether positive goal has been reached More...
void doListen ()
 read the next incoming message 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...

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< AsyncJobid
 job identifier More...

Private Member Functions

void registerSelf ()
void handleRegistrationResponse (const HereIamMessage &msg)
 let Coordinator know this strand exists 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)
 Strand (const Strand &)
Strandoperator= (const Strand &)

Private Attributes

bool isRegistered
 whether Coordinator ACKed registration (unused) More...

Detailed Description

Definition at line 27 of file Strand.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Strand() [1/2]

Ipc::Strand::Strand ( )

Definition at line 39 of file

◆ Strand() [2/2]

Ipc::Strand::Strand ( const Strand )

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 101 of file

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

Referenced by AsyncJob::swanSong().


Ipc::Strand::CBDATA_CLASS ( Strand  )

◆ clearTimeout()

void Ipc::UdsOp::clearTimeout ( )

Definition at line 62 of file

References commUnsetConnTimeout(), and Ipc::UdsOp::conn().

Referenced by handleRegistrationResponse(), and Ipc::UdsOp::timedout().

◆ conn()

◆ CoordinatorAddr()

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ doListen()

◆ done()

◆ doneAll()

bool Ipc::Port::doneAll ( ) const

Reimplemented from AsyncJob.

Definition at line 46 of file

◆ handleCacheMgrRequest()

void Ipc::Strand::handleCacheMgrRequest ( const Mgr::Request request)

◆ handleCacheMgrResponse()

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

Definition at line 142 of file

References Ipc::Forwarder::HandleRemoteAck(), and Ipc::Response::requestId.

Referenced by receive().

◆ handleRegistrationResponse()

void Ipc::Strand::handleRegistrationResponse ( const HereIamMessage msg)

◆ handleSnmpRequest()

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

Definition at line 148 of file

References debugs, HERE(), Snmp::Request::pdu, Ipc::Request::requestId, and Snmp::SendResponse().

Referenced by receive().

◆ handleSnmpResponse()

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

Definition at line 154 of file

References debugs, Ipc::Forwarder::HandleRemoteAck(), HERE(), and Ipc::Response::requestId.

Referenced by receive().

◆ MakeAddr()

◆ mustStop()

void AsyncJob::mustStop ( const char *  aReason)

Definition at line 69 of file

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

Referenced by HttpStateData::abortAll(), Ftp::Client::abortAll(), Comm::TcpAcceptor::acceptOne(), Adaptation::Ecap::XactionRep::adaptationAborted(), Adaptation::AccessCheck::callBack(), AsyncJob::callException(), Security::PeerConnector::connectionClosed(), HttpStateData::continueAfterParsingHeader(), Ftp::Client::ctrlClosed(), Adaptation::Iterator::handleAdaptationBlock(), Adaptation::Iterator::handleAdaptationError(), Log::TcpLogger::handleClosure(), Adaptation::Icap::Xaction::handleCommClosed(), Http::Tunneler::handleConnectionClosure(), Mgr::Forwarder::handleError(), Ipc::Forwarder::handleError(), Ipc::Forwarder::handleException(), Ipc::Inquirer::handleException(), HttpStateData::handleMoreRequestBodyAvailable(), Ipc::Inquirer::handleRemoteAck(), Ipc::Forwarder::handleTimeout(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), Adaptation::Icap::ModXact::noteBodyConsumerAborted(), Snmp::Forwarder::noteCommClosed(), Snmp::Inquirer::noteCommClosed(), Mgr::Inquirer::noteCommClosed(), Mgr::Forwarder::noteCommClosed(), Mgr::StoreToCommWriter::noteCommClosed(), Adaptation::Icap::Xaction::noteCommRead(), Rock::HeaderUpdater::noteDoneReading(), Adaptation::Iterator::noteInitiatorAborted(), Adaptation::Icap::Xaction::noteInitiatorAborted(), Adaptation::Ecap::XactionRep::noteInitiatorAborted(), HttpStateData::readReply(), Comm::ConnOpener::sendAnswer(), Rock::Rebuild::start(), Security::PeerConnector::start(), HttpStateData::start(), Ipc::UdsSender::timedout(), and HttpStateData::wroteLast().

◆ operator=()

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

◆ receive()

◆ registerSelf()

void Ipc::Strand::registerSelf ( )

◆ setOptions()

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

Definition at line 35 of file

References Ipc::UdsOp::options.

Referenced by Ipc::Port::Port(), and Ipc::UdsOp::timedout().

◆ setTimeout()

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

◆ start()

void Ipc::Strand::start ( )

Implements Ipc::Port.

Definition at line 45 of file

References registerSelf(), and Ipc::Port::start().

◆ Start()

◆ status()

◆ swanSong()

◆ timedout()

void Ipc::Strand::timedout ( )

Reimplemented from Ipc::UdsOp.

Definition at line 161 of file

References debugs, fatalf(), HERE(), isRegistered, and KidIdentifier.

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ address

struct sockaddr_un Ipc::UdsOp::address

Definition at line 36 of file UdsOp.h.

Referenced by Ipc::UdsOp::conn(), and Ipc::UdsSender::UdsSender().

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 72 of file AsyncJob.h.

◆ inCall

◆ isRegistered

bool Ipc::Strand::isRegistered

Definition at line 51 of file Strand.h.

Referenced by registerSelf(), and timedout().

◆ stopReason

const char* AsyncJob::stopReason

◆ typeName

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






Web Site Translations