#include <ConnOpener.h>

Inheritance diagram for Comm::ConnOpener:

Collaboration diagram for Comm::ConnOpener:

Classes
struct	Calls
	handles to calls which we may need to cancel. More...

Public Types
typedef CbcPointer< ConnOpener >	Pointer

Public Member Functions
void	noteAbort ()

virtual bool	doneAll () const
	whether positive goal has been reached More...

	ConnOpener (Comm::ConnectionPointer &, AsyncCall::Pointer &handler, time_t connect_timeout)

	~ConnOpener ()

void	setHost (const char *)
	set the hostname note for this connection More...

const char *	getHost () const
	get the hostname noted for this connection 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 Pointer	Start (AsyncJob *job)
	starts a freshly created job (i.e., makes the job asynchronous) More...

Protected Member Functions
virtual void	start ()
	called by AsyncStart; do not call directly More...

virtual void	swanSong ()

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

bool	done () const
	the job is destroyed in callEnd() when done() More...

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 Member Functions
	CBDATA_CLASS (ConnOpener)

	ConnOpener (const ConnOpener &)

ConnOpener &	operator= (const ConnOpener &c)

void	earlyAbort (const CommCloseCbParams &)

void	timeout (const CommTimeoutCbParams &)

void	sendAnswer (Comm::Flag errFlag, int xerrno, const char *why)

void	doConnect ()
	Make an FD connection attempt. More...

void	connected ()

void	lookupLocalAddress ()

void	retrySleep ()
	Close and wait a little before trying to open and connect again. More...

void	restart ()
	called at the end of Comm::ConnOpener::DelayedConnectRetry event More...

bool	createFd ()

void	closeFd ()
	cleans I/O state and ends I/O for temporaryFd_ More...

void	keepFd ()
	cleans I/O state and moves temporaryFd_ to the conn_ for long-term use More...

void	cleanFd ()

void	cancelSleep ()
	cleans up this job sleep state More...

Static Private Member Functions
static void	InProgressConnectRetry (int fd, void *data)

static void	DelayedConnectRetry (void *data)

Private Attributes
char *	host_
	domain name we are trying to connect to. More...

int	temporaryFd_
	the FD being opened. Do NOT set conn_->fd until it is fully open. More...

Comm::ConnectionPointer	conn_
	single connection currently to be opened. More...

AsyncCall::Pointer	callback_
	handler to be called on connection completion. More...

int	totalTries_
	total number of connection attempts over all destinations so far. More...

int	failRetries_
	number of retries current destination has been tried. More...

time_t	deadline_
	if we are not done by then, we will call back with Comm::TIMEOUT More...

struct Comm::ConnOpener::Calls	calls_

Detailed Description

Async-opener of a Comm connection.

Definition at line 25 of file ConnOpener.h.

Member Typedef Documentation

typedef CbcPointer<ConnOpener> Comm::ConnOpener::Pointer

Definition at line 32 of file ConnOpener.h.

Constructor & Destructor Documentation

Comm::ConnOpener::ConnOpener	(	Comm::ConnectionPointer &	c,
		AsyncCall::Pointer &	handler,
		time_t	connect_timeout
	)

Definition at line 33 of file ConnOpener.cc.

References debugs.

Comm::ConnOpener::~ConnOpener ( )

Definition at line 46 of file ConnOpener.cc.

References safe_free.

Comm::ConnOpener::ConnOpener ( const ConnOpener & )

private

Member Function Documentation

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.

void Comm::ConnOpener::cancelSleep ( )

private

Definition at line 388 of file ConnOpener.cc.

References debugs.

Comm::ConnOpener::CBDATA_CLASS ( ConnOpener )

private

void Comm::ConnOpener::cleanFd ( )

private

cleans up this job I/O state without closing temporaryFd required before closing temporaryFd or keeping it in conn_ leaves FD bare so must only be called via closeFd() or keepFd()

Definition at line 153 of file ConnOpener.cc.

References comm_remove_close_handler(), COMM_SELECT_WRITE, debugs, fd_table, HERE(), Must, NULL, Comm::SetSelect(), fde::timeout, fde::timeoutHandler, fde::write_data, and fde::write_handler.