AsyncCall Class Reference

#include <AsyncCall.h>

Inheritance diagram for AsyncCall:

Collaboration diagram for AsyncCall:

Public Types
using	Pointer = AsyncCallPointer

Public Member Functions
	AsyncCall (int aDebugSection, int aDebugLevel, const char *aName)
	~AsyncCall () override
void	make ()
bool	cancel (const char *reason)
bool	canceled () const
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
void	setNext (AsyncCall::Pointer aNext)
AsyncCall::Pointer &	Next ()

Public Attributes
const char *const	name
CodeContext::Pointer	codeContext
	what the callee is expected to work on
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
	for AsyncCallList and similar lists

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

Private Attributes
const char *	isCanceled

Detailed Description

Definition at line 40 of file AsyncCall.h.

Member Typedef Documentation

Pointer

using AsyncCall::Pointer = AsyncCallPointer

Definition at line 43 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 ( )

override

Definition at line 33 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 56 of file AsyncCall.cc.

References debugLevel, debugs, debugSection, isCanceled, and name.

Referenced by AsyncJob::canBeCalled(), JobWaitBase::cancel(), JobDialer< Job >::canDial(), EventDialer::canDial(), BodyProducerDialer::canDial(), BodyConsumerDialer::canDial(), comm_remove_close_handler(), comm_remove_close_handler(), HappyOrderEnforcer::dequeue(), Comm::ReadCancel(), storeUnregister(), and StoreEntry::unregisterAbortCallback().

canceled()

bool AsyncCall::canceled ( ) const

inline

Definition at line 53 of file AsyncCall.h.

References isCanceled.

Referenced by commCallCloseHandlers().

canFire()

bool AsyncCall::canFire ( )

protectedvirtual

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

Definition at line 67 of file AsyncCall.cc.

References isCanceled.

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

dequeue()

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

Definition at line 84 of file AsyncCall.cc.

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

Referenced by comm_remove_close_handler(), and comm_remove_close_handler().

fire()

virtual void AsyncCall::fire ( )

protectedpure virtual

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

Referenced by make().

getDialer()

virtual CallDialer * AsyncCall::getDialer ( )

pure virtual

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

Referenced by GetCommParams(), and print().

make()

void AsyncCall::make

(

)

Definition at line 39 of file AsyncCall.cc.

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

Next()

AsyncCall::Pointer & AsyncCall::Next ( )

inline

Definition at line 66 of file AsyncCall.h.

References theNext.

Referenced by AsyncCallList::add(), comm_remove_close_handler(), comm_remove_close_handler(), commCallCloseHandlers(), dequeue(), and AsyncCallList::extract().

print()

void AsyncCall::print

(

std::ostream &

os

)

Definition at line 74 of file AsyncCall.cc.

References getDialer(), and name.

Referenced by operator<<().

setNext()

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

inline

Definition at line 62 of file AsyncCall.h.

References theNext.

Referenced by AsyncCallList::add(), comm_add_close_handler(), commCallCloseHandlers(), dequeue(), and AsyncCallList::extract().

Member Data Documentation

codeContext

CodeContext::Pointer AsyncCall::codeContext

Definition at line 74 of file AsyncCall.h.

Referenced by CallSubscription< Call_ >::callback(), and ScheduleCall().

debugLevel

const int AsyncCall::debugLevel

Definition at line 77 of file AsyncCall.h.

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

debugSection

const int AsyncCall::debugSection

Definition at line 76 of file AsyncCall.h.

Referenced by AsyncCall(), AsyncJob::callEnd(), AsyncJob::callStart(), cancel(), JobWaitBase::cancel(), BodyProducerDialer::canDial(), BodyConsumerDialer::canDial(), JobDialer< Job >::dial(), make(), and ScheduleCall().

id

const InstanceId<AsyncCall> AsyncCall::id

Definition at line 78 of file AsyncCall.h.

Referenced by JobWaitBase::print(), and ScheduleCall().

isCanceled

const char* AsyncCall::isCanceled

private

Definition at line 88 of file AsyncCall.h.

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

name

const char* const AsyncCall::name

Definition at line 71 of file AsyncCall.h.

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

theNext

AsyncCall::Pointer AsyncCall::theNext

protected

Definition at line 85 of file AsyncCall.h.

Referenced by ~AsyncCall(), Next(), and setNext().

---

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

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