AsyncCall Class Reference

#include <AsyncCall.h>

Inheritance diagram for AsyncCall:

Collaboration diagram for AsyncCall:

Public Types
typedef RefCount< AsyncCall >	Pointer

Public Member Functions
	AsyncCall (int aDebugSection, int aDebugLevel, const char *aName)
virtual	~AsyncCall ()
void	make ()
bool	cancel (const char *reason)
bool	canceled ()
virtual CallDialer *	getDialer ()=0
void	print (std::ostream &os)
void	dequeue (AsyncCall::Pointer &head, AsyncCall::Pointer &prev)
	remove us from the queue; we are head unless we are queued after prev More...
void	setNext (AsyncCall::Pointer aNext)
AsyncCall::Pointer &	Next ()

Public Attributes
const char *const	name
const int	debugSection
const int	debugLevel
const InstanceId< AsyncCall >	id

Protected Member Functions
virtual bool	canFire ()
virtual void	fire ()=0

Protected Attributes
AsyncCall::Pointer	theNext

Private Member Functions
	AsyncCall ()
	AsyncCall (const AsyncCall &)

Private Attributes
const char *	isCanceled

Friends
class	AsyncCallQueue

Detailed Description

Todo:

add unique call IDs

CBDATA_CLASS kids

Definition at line 44 of file AsyncCall.h.

Member Typedef Documentation

Pointer

typedef RefCount<AsyncCall> AsyncCall::Pointer

Definition at line 47 of file AsyncCall.h.

Constructor & Destructor Documentation

AsyncCall() [1/3]

AsyncCall::AsyncCall	(	int	aDebugSection,
		int	aDebugLevel,
		const char *	aName
	)

Definition at line 21 of file AsyncCall.cc.

References debugLevel, debugs, debugSection, and name.

~AsyncCall()

AsyncCall::~AsyncCall ( )

virtual

Definition at line 29 of file AsyncCall.cc.

References assert, and theNext.

AsyncCall() [2/3]

AsyncCall::AsyncCall ( )

private

AsyncCall() [3/3]

AsyncCall::AsyncCall ( const AsyncCall &  )

private

Member Function Documentation

cancel()

bool AsyncCall::cancel

(

const char *

reason

)

Definition at line 52 of file AsyncCall.cc.

References debugLevel, debugs, debugSection, HERE(), isCanceled, and name.

Referenced by AsyncJob::canBeCalled(), Comm::IoCallback::cancel(), JobDialer< BodyConsumer >::canDial(), EventDialer::canDial(), BodyProducerDialer::canDial(), BodyConsumerDialer::canDial(), CommCbFunPtrCallT< Dialer >::canFire(), Comm::ConnOpener::cleanFd(), Ftp::Server::closeDataConnection(), PeerPoolMgr::handleSecureClosure(), PeerPoolMgr::handleSecuredPeer(), Adaptation::Icap::Xaction::handleSecuredPeer(), Adaptation::Icap::Xaction::noteCommClosed(), DeferredReadManager::popHead(), Comm::ReadCancel(), Ftp::Gateway::timeout(), and Ftp::Client::~Client().

canceled()

bool AsyncCall::canceled ( )

inline

Definition at line 58 of file AsyncCall.h.

References dequeue(), getDialer(), head, isCanceled, NULL, and print().

Referenced by Comm::ConnOpener::createFd(), Comm::ConnOpener::doneAll(), Downloader::doneAll(), Security::PeerConnector::doneAll(), and Comm::ConnOpener::sendAnswer().

canFire()

bool AsyncCall::canFire ( )

protectedvirtual

Reimplemented in CommCbFunPtrCallT< Dialer >, AsyncCallT< Dialer >, and AsyncCallT< AnswerDialer >.

Definition at line 63 of file AsyncCall.cc.

References isCanceled.

Referenced by AsyncCallT< AnswerDialer >::canFire(), CommCbFunPtrCallT< Dialer >::canFire(), and make().

dequeue()

void AsyncCall::dequeue	(	AsyncCall::Pointer &	head,
		AsyncCall::Pointer &	prev
	)

Definition at line 80 of file AsyncCall.cc.

References Next(), NULL, and setNext().

Referenced by canceled().

fire()

virtual void AsyncCall::fire ( )

protectedpure virtual

Implemented in CommCbFunPtrCallT< Dialer >, AsyncCallT< Dialer >, AsyncCallT< AnswerDialer >, and Adaptation::AnswerCall.

Referenced by make().

getDialer()

virtual CallDialer* AsyncCall::getDialer ( )

pure virtual

Implemented in CommCbFunPtrCallT< Dialer >, AsyncCallT< Dialer >, and AsyncCallT< AnswerDialer >.

Referenced by Security::PeerConnector::bail(), Downloader::callBack(), Security::PeerConnector::callBack(), canceled(), Ipc::Inquirer::HandleRemoteAck(), Security::PeerConnector::PeerConnector(), print(), sslCrtvdHandleReplyWrapper(), Ipc::StartListening(), Ssl::CertValidationHelper::Submit(), and Ssl::PeekingPeerConnector::tunnelInsteadOfNegotiating().

make()

void AsyncCall::make

(

)

Definition at line 35 of file AsyncCall.cc.

References canFire(), debugLevel, debugs, debugSection, fire(), HERE(), isCanceled, and name.

Referenced by AsyncCallQueue::fireNext().

Next()

AsyncCall::Pointer& AsyncCall::Next ( )

inline

Definition at line 71 of file AsyncCall.h.

References theNext.

Referenced by dequeue().

print()

void AsyncCall::print

(

std::ostream &

os

)

Todo:

make this method const by providing a const getDialer()

Definition at line 70 of file AsyncCall.cc.

References getDialer(), and name.

Referenced by canceled(), operator<<(), and CallDialer::~CallDialer().

setNext()

void AsyncCall::setNext ( AsyncCall::Pointer  aNext )

inline

Definition at line 67 of file AsyncCall.h.

References theNext.

Referenced by dequeue().

Friends And Related Function Documentation

AsyncCallQueue

friend class AsyncCallQueue

friend

Definition at line 48 of file AsyncCall.h.

Member Data Documentation

debugLevel

const int AsyncCall::debugLevel

Definition at line 78 of file AsyncCall.h.

Referenced by AsyncCall(), AsyncJob::callEnd(), AsyncJob::callStart(), cancel(), BodyProducerDialer::canDial(), BodyConsumerDialer::canDial(), AsyncCallQueue::fireNext(), and make().

debugSection

const int AsyncCall::debugSection

Definition at line 77 of file AsyncCall.h.

Referenced by AsyncCall(), AsyncJob::callEnd(), AsyncJob::callStart(), cancel(), BodyProducerDialer::canDial(), BodyConsumerDialer::canDial(), JobDialer< BodyConsumer >::dial(), AsyncCallQueue::fireNext(), and make().

id

const InstanceId<AsyncCall> AsyncCall::id

Definition at line 79 of file AsyncCall.h.

Referenced by Comm::ConnOpener::sendAnswer().

isCanceled

const char* AsyncCall::isCanceled

private

Definition at line 89 of file AsyncCall.h.

Referenced by cancel(), canceled(), canFire(), and make().

name

const char* const AsyncCall::name

Definition at line 76 of file AsyncCall.h.

Referenced by AsyncCall(), cancel(), JobDialer< BodyConsumer >::dial(), make(), and print().

theNext

AsyncCall::Pointer AsyncCall::theNext

protected

Definition at line 86 of file AsyncCall.h.

Referenced by AsyncCallQueue::fireNext(), Next(), AsyncCallQueue::schedule(), setNext(), and ~AsyncCall().

---

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

• src/base/AsyncCall.h
• src/base/AsyncCall.cc