Ipc::UdsOp Class Reference

#include <UdsOp.h>

Inheritance diagram for Ipc::UdsOp:

Collaboration diagram for Ipc::UdsOp:

Public Types
typedef CbcPointer< AsyncJob >	Pointer

Public Member Functions
	UdsOp (const String &pathAddr)
virtual	~UdsOp ()
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 void	Start (const Pointer &job)

Public Attributes
struct sockaddr_un	address
	UDS address from path; treat as read-only. More...
const InstanceId< AsyncJob >	id
	job identifier More...

Protected Member Functions
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	start ()
	called by AsyncStart; do not call directly More...
virtual bool	doneAll () const
	whether positive goal has been reached 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...
bool	started_ = false
	Start() has finished successfully. More...
bool	swanSang_ = false
	swanSong() was called More...

Private Member Functions
void	noteTimeout (const CommTimeoutCbParams &p)
	Comm timeout callback; calls timedout() More...
	UdsOp (const UdsOp &)
UdsOp &	operator= (const UdsOp &)

Private Attributes
int	options
	UDS options. More...
Comm::ConnectionPointer	conn_
	UDS descriptor. More...

Detailed Description

code shared by unix-domain socket senders (e.g., UdsSender or Coordinator) and receivers (e.g. Port or Coordinator)

Definition at line 30 of file UdsOp.h.

Member Typedef Documentation

Pointer

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

UdsOp() [1/2]

Ipc::UdsOp::UdsOp

(

const String &

pathAddr

)

Definition at line 19 of file UdsOp.cc.

References debugs, and HERE().

~UdsOp()

Ipc::UdsOp::~UdsOp ( )

virtual

Definition at line 27 of file UdsOp.cc.

References debugs, HERE(), Comm::IsConnOpen(), and NULL.

UdsOp() [2/2]

Ipc::UdsOp::UdsOp ( const UdsOp &  )

private

Member Function Documentation

callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 137 of file AsyncJob.cc.

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

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

callException()

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

virtualinherited

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

Definition at line 128 of file AsyncJob.cc.

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

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

callStart()

void AsyncJob::callStart ( AsyncCall &  call )

inherited

called just before the called method

Definition at line 115 of file AsyncJob.cc.

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

canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall &  call ) const

inherited

Definition at line 102 of file AsyncJob.cc.

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

clearTimeout()

void Ipc::UdsOp::clearTimeout ( )

protected

Definition at line 62 of file UdsOp.cc.

References commUnsetConnTimeout(), and conn.

conn()

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

protected

Definition at line 41 of file UdsOp.cc.

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

deleteThis()

void AsyncJob::deleteThis ( const char *  aReason )

protectedinherited

Definition at line 50 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed().

done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 91 of file AsyncJob.cc.

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

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

doneAll()

bool AsyncJob::doneAll ( ) const

protectedvirtualinherited

Reimplemented in HappyConnOpener, Rock::Rebuild, Rock::HeaderUpdater, Snmp::Inquirer, Server, Security::PeerConnector, PeerPoolMgr, Mgr::StoreToCommWriter, Mgr::Inquirer, Log::TcpLogger, Ipc::UdsSender, Ipc::Port, Ipc::Inquirer, Ipc::Forwarder, Downloader, Comm::TcpAcceptor, Comm::ConnOpener, Http::Tunneler, Client, ClientHttpRequest, ConnStateData, BodySink, Adaptation::Iterator, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, Adaptation::Icap::ModXact, Adaptation::Icap::Launcher, Adaptation::Ecap::XactionRep, and Adaptation::AccessCheck.

Definition at line 97 of file AsyncJob.cc.

Referenced by AsyncJob::done(), Adaptation::Ecap::XactionRep::doneAll(), Adaptation::Icap::Launcher::doneAll(), Adaptation::Icap::ServiceRep::doneAll(), Adaptation::Icap::Xaction::doneAll(), Adaptation::Iterator::doneAll(), BodySink::doneAll(), ConnStateData::doneAll(), ClientHttpRequest::doneAll(), Client::doneAll(), Comm::ConnOpener::doneAll(), Comm::TcpAcceptor::doneAll(), Downloader::doneAll(), Ipc::UdsSender::doneAll(), Log::TcpLogger::doneAll(), PeerPoolMgr::doneAll(), Security::PeerConnector::doneAll(), Server::doneAll(), Rock::HeaderUpdater::doneAll(), and Rock::Rebuild::doneAll().

handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

mustStop()

void AsyncJob::mustStop ( const char *  aReason )

protectedinherited

Definition at line 70 of file AsyncJob.cc.

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

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::drop1xx(), HttpStateData::handleMoreRequestBodyAvailable(), AsyncJob::handleStopRequest(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), HttpStateData::proceedAfter1xx(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

noteTimeout()

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

private

Definition at line 67 of file UdsOp.cc.

Referenced by setTimeout().

operator=()

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

private

setOptions()

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

protected

Definition at line 35 of file UdsOp.cc.

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

setTimeout()

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

protected

Definition at line 54 of file UdsOp.cc.

References asyncCall(), commSetConnTimeout(), conn, handler(), and noteTimeout().

start()

void AsyncJob::start ( )

protectedvirtualinherited

Reimplemented in Ipc::Port, Ftp::Server, HappyConnOpener, Rock::Rebuild, Rock::HeaderUpdater, Snmp::Inquirer, Server, Http::One::Server, Security::PeerConnector, PeerPoolMgr, Mgr::StoreToCommWriter, Mgr::Inquirer, Mgr::Filler, Mgr::ActionWriter, Log::TcpLogger, Ipc::UdsSender, Ipc::Strand, Ipc::Inquirer, Ipc::Forwarder, Ipc::Coordinator, HttpStateData, Downloader, Comm::TcpAcceptor, Comm::ConnOpener, Http::Tunneler, Ftp::Relay, Ftp::Gateway, Ftp::Client, ConnStateData, Adaptation::Iterator, Adaptation::Icap::Xaction, Adaptation::Icap::OptXact, Adaptation::Icap::ModXact, Adaptation::Icap::Launcher, Adaptation::Ecap::XactionRep, and Adaptation::AccessCheck.

Definition at line 44 of file AsyncJob.cc.

Referenced by Adaptation::AccessCheck::start(), Adaptation::Icap::Launcher::start(), Adaptation::Icap::Xaction::start(), Adaptation::Iterator::start(), ConnStateData::start(), Http::Tunneler::start(), Ipc::UdsSender::start(), PeerPoolMgr::start(), Security::PeerConnector::start(), Ipc::Port::start(), and AsyncJob::Start().

Start()

void AsyncJob::Start ( const Pointer &  job )

staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 24 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by Ftp::Server::AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

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

Definition at line 167 of file AsyncJob.cc.

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

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

swanSong()

virtual void AsyncJob::swanSong ( )

inlineprotectedvirtualinherited

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

Definition at line 59 of file AsyncJob.h.

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

timedout()

virtual void Ipc::UdsOp::timedout ( )

inlineprotectedvirtual

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

Definition at line 40 of file UdsOp.h.

toCbdata()

virtual void* CbdataParent::toCbdata ( )

pure virtualinherited

Implemented in HttpStateData, ClientHttpRequest, and BodySink.

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

Member Data Documentation

address

struct sockaddr_un Ipc::UdsOp::address

Definition at line 34 of file UdsOp.h.

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

conn_

Comm::ConnectionPointer Ipc::UdsOp::conn_

private

Definition at line 56 of file UdsOp.h.

id

const InstanceId<AsyncJob> AsyncJob::id

inherited

Definition at line 73 of file AsyncJob.h.

inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 81 of file AsyncJob.h.

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

options

int Ipc::UdsOp::options

private

Definition at line 55 of file UdsOp.h.

started_

bool AsyncJob::started_ = false

protectedinherited

Definition at line 83 of file AsyncJob.h.

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

stopReason

const char* AsyncJob::stopReason

protectedinherited

Definition at line 79 of file AsyncJob.h.

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

swanSang_

bool AsyncJob::swanSang_ = false

protectedinherited

Definition at line 84 of file AsyncJob.h.

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

typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 80 of file AsyncJob.h.

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

---

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

• src/ipc/UdsOp.h
• src/ipc/UdsOp.cc