helper_stateful_server Class Reference

represents a single "stateful helper" process More...

#include <helper.h>

Inheritance diagram for helper_stateful_server:

Collaboration diagram for helper_stateful_server:

Public Types
typedef std::list< Helper::Xaction * >	Requests

Public Member Functions
	~helper_stateful_server () override
void	reserve ()
void	clearReservation ()
bool	reserved () override
	whether the server is locked for exclusive use by a client More...
helper *	getParent () const override
	the helper object that created this server More...
void	closePipesSafely (const char *name)
void	closeWritePipeSafely (const char *name)
virtual void	dropQueued ()
	dequeues and sends a Helper::Unknown answer to all queued requests More...
void	initStats ()
virtual void *	toCbdata ()=0

Static Public Member Functions
static void	HelperServerClosed (helper_stateful_server *srv)
	close handler to handle exited server processes More...

Public Attributes
statefulhelper *	parent
Helper::ReservationId	reservationId
	"confirmation ID" of the last More...
time_t	reservationStart
	when the last reservation was made More...
const InstanceId< HelperServerBase >	index
int	pid
Ip::Address	addr
Comm::ConnectionPointer	readPipe
Comm::ConnectionPointer	writePipe
void *	hIpc
char *	rbuf
size_t	rbuf_sz
size_t	roffset
struct timeval	dispatch_time
struct timeval	answer_time
dlink_node	link
struct HelperServerBase::_helper_flags	flags
Requests	requests
	requests in order of submission/expiration More...
struct {
uint64_t   uses
uint64_t   replies
uint64_t   pending
uint64_t   releases
uint64_t   timedout
}	stats

Private Member Functions
	CBDATA_CHILD (helper_stateful_server)
virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

Detailed Description

Definition at line 294 of file helper.h.

Member Typedef Documentation

Requests

typedef std::list<Helper::Xaction *> HelperServerBase::Requests

inherited

Definition at line 226 of file helper.h.

Constructor & Destructor Documentation

~helper_stateful_server()

helper_stateful_server::~helper_stateful_server ( )

override

Definition at line 182 of file helper.cc.

References assert, statefulhelper::cancelReservation(), cbdataReferenceDone, helper::childs, HelperServerBase::closeWritePipeSafely(), dlinkDelete(), helper::id_name, Comm::IsConnOpen(), HelperServerBase::link, Helper::ChildConfig::n_running, parent, HelperServerBase::requests, reservationId, helper::servers, and HelperServerBase::writePipe.

Member Function Documentation

CBDATA_CHILD()

helper_stateful_server::CBDATA_CHILD ( helper_stateful_server  )

private

clearReservation()

void helper_stateful_server::clearReservation

(

)

Definition at line 632 of file helper.cc.

References Helper::ReservationId::clear(), debugs, HelperServerBase::index, reservationId, reservationStart, and HelperServerBase::stats.

Referenced by statefulhelper::cancelReservation(), and statefulhelper::reserveServer().

closePipesSafely()

void HelperServerBase::closePipesSafely ( const char *  name )

inherited

Closes pipes to the helper safely. Handles the case where the read and write pipes are the same FD.

Parameters

name	displayed for the helper being shutdown if logging an error

Definition at line 74 of file helper.cc.

References Comm::Connection::close(), HelperServerBase::_helper_flags::closing, DBG_IMPORTANT, debugs, Comm::Connection::fd, HelperServerBase::flags, getCurrentTime(), HelperServerBase::hIpc, HelperServerBase::index, HelperServerBase::pid, HelperServerBase::readPipe, and HelperServerBase::writePipe.

Referenced by helperHandleRead(), helperReturnBuffer(), helperShutdown(), helperStatefulHandleRead(), and helperStatefulShutdown().

closeWritePipeSafely()

void HelperServerBase::closeWritePipeSafely ( const char *  name )

inherited

Closes the reading pipe. If the read and write sockets are the same the write pipe will also be closed. Otherwise its left open for later handling.

Parameters

name	displayed for the helper being shutdown if logging an error

Definition at line 102 of file helper.cc.

References Comm::Connection::close(), HelperServerBase::_helper_flags::closing, DBG_IMPORTANT, debugs, Comm::Connection::fd, HelperServerBase::flags, getCurrentTime(), HelperServerBase::hIpc, HelperServerBase::index, HelperServerBase::pid, HelperServerBase::readPipe, and HelperServerBase::writePipe.

Referenced by helper_server::~helper_server(), ~helper_stateful_server(), helperReturnBuffer(), and helperStatefulServerDone().

dropQueued()

void HelperServerBase::dropQueued ( )

virtualinherited

Reimplemented in helper_server.

Definition at line 128 of file helper.cc.

References HelperServerBase::requests.

Referenced by helper_server::dropQueued(), and HelperServerClosed().

finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

getParent()

helper * helper_stateful_server::getParent ( ) const

inlineoverridevirtual

Implements HelperServerBase.

Definition at line 305 of file helper.h.

References parent.

Referenced by HelperServerClosed().

HelperServerClosed()

void helper_stateful_server::HelperServerClosed ( helper_stateful_server *  srv )

static

Definition at line 876 of file helper.cc.

References DBG_IMPORTANT, debugs, HelperServerBase::dropQueued(), getParent(), helper::handleKilledServer(), and helperStatefulOpenServers().

Referenced by helperStatefulOpenServers().

initStats()

void HelperServerBase::initStats ( )

inherited

Definition at line 64 of file helper.cc.

References HelperServerBase::stats.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

reserve()

void helper_stateful_server::reserve

(

)

Definition at line 623 of file helper.cc.

References assert, debugs, HelperServerBase::index, Helper::ReservationId::Next(), reservationId, reservationStart, and squid_curtime.

Referenced by statefulhelper::reserveServer().

reserved()

bool helper_stateful_server::reserved ( )

inlineoverridevirtual

Implements HelperServerBase.

Definition at line 304 of file helper.h.

References reservationId, and Helper::ReservationId::reserved().

Referenced by helperStatefulServerDone(), helperStatefulShutdown(), statefulhelper::reserveServer(), and StatefulGetFirstAvailable().

toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

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

Member Data Documentation

addr

Ip::Address HelperServerBase::addr

inherited

Definition at line 206 of file helper.h.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

answer_time

struct timeval HelperServerBase::answer_time

inherited

Definition at line 216 of file helper.h.

Referenced by helperReturnBuffer(), helperStatefulHandleRead(), and helper::packStatsInto().

dispatch_time

struct timeval HelperServerBase::dispatch_time

inherited

Definition at line 215 of file helper.h.

Referenced by helperReturnBuffer(), helperStatefulDispatch(), helperStatefulHandleRead(), and helper::packStatsInto().

flags

struct HelperServerBase::_helper_flags HelperServerBase::flags

inherited

Referenced by HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), GetFirstAvailable(), helper::handleKilledServer(), helperDispatch(), helperDispatchWriteDone(), helperReturnBuffer(), helperShutdown(), helperStatefulServerDone(), helperStatefulShutdown(), helper::packStatsInto(), and StatefulGetFirstAvailable().

hIpc

void* HelperServerBase::hIpc

inherited

Definition at line 209 of file helper.h.

Referenced by HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), helperOpenServers(), and helperStatefulOpenServers().

index

const InstanceId<HelperServerBase> HelperServerBase::index

inherited

Helper program identifier; does not change when contents do, including during assignment

Definition at line 204 of file helper.h.

Referenced by clearReservation(), HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), GetFirstAvailable(), helper::handleKilledServer(), helperDispatch(), helperDispatchWriteDone(), helperHandleRead(), helperReturnBuffer(), helperShutdown(), helperStatefulDispatch(), helperStatefulHandleRead(), helperStatefulKickQueue(), helperStatefulShutdown(), helper::packStatsInto(), reserve(), and StatefulGetFirstAvailable().

link

dlink_node HelperServerBase::link

inherited

Definition at line 218 of file helper.h.

Referenced by helper_server::~helper_server(), ~helper_stateful_server(), helperOpenServers(), and helperStatefulOpenServers().

parent

statefulhelper* helper_stateful_server::parent

Definition at line 310 of file helper.h.

Referenced by ~helper_stateful_server(), getParent(), helperStatefulDispatch(), helperStatefulHandleRead(), helperStatefulOpenServers(), and helperStatefulServerDone().

pending

uint64_t HelperServerBase::pending

inherited

Definition at line 232 of file helper.h.

Referenced by GetFirstAvailable(), helperDispatch(), helperHandleRead(), helperReturnBuffer(), helperShutdown(), helperStatefulDispatch(), helperStatefulHandleRead(), helperStatefulServerDone(), helperStatefulShutdown(), helper::packStatsInto(), and StatefulGetFirstAvailable().

pid

int HelperServerBase::pid

inherited

Definition at line 205 of file helper.h.

Referenced by HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), helperOpenServers(), helperStatefulOpenServers(), and helper::packStatsInto().

rbuf

char* HelperServerBase::rbuf

inherited

Definition at line 211 of file helper.h.

Referenced by HelperServerBase::~HelperServerBase(), helperHandleRead(), helperOpenServers(), helperStatefulHandleRead(), and helperStatefulOpenServers().

rbuf_sz

size_t HelperServerBase::rbuf_sz

inherited

Definition at line 212 of file helper.h.

Referenced by HelperServerBase::~HelperServerBase(), helperHandleRead(), helperOpenServers(), helperReturnBuffer(), helperStatefulHandleRead(), and helperStatefulOpenServers().

readPipe

Comm::ConnectionPointer HelperServerBase::readPipe

inherited

Definition at line 207 of file helper.h.

Referenced by HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), helperHandleRead(), helperOpenServers(), helperStatefulHandleRead(), helperStatefulOpenServers(), and helper::packStatsInto().

releases

uint64_t HelperServerBase::releases

inherited

Definition at line 233 of file helper.h.

replies

uint64_t HelperServerBase::replies

inherited

Definition at line 231 of file helper.h.

Referenced by helper::handleKilledServer(), helperReturnBuffer(), helperStatefulHandleRead(), and helper::packStatsInto().

requests

Requests HelperServerBase::requests

inherited

Definition at line 227 of file helper.h.

Referenced by helper_server::~helper_server(), ~helper_stateful_server(), helper_server::checkForTimedOutRequests(), HelperServerBase::dropQueued(), helperDispatch(), helperStatefulDispatch(), helperStatefulHandleRead(), helper::packStatsInto(), helper_server::popRequest(), and helper_server::requestTimeout().

reservationId

Helper::ReservationId helper_stateful_server::reservationId

Definition at line 316 of file helper.h.

Referenced by ~helper_stateful_server(), clearReservation(), helperStatefulDispatch(), helperStatefulHandleRead(), reserve(), reserved(), statefulhelper::reserveServer(), and StatefulGetFirstAvailable().

reservationStart

time_t helper_stateful_server::reservationStart

Definition at line 317 of file helper.h.

Referenced by clearReservation(), helperStatefulOpenServers(), reserve(), and StatefulGetFirstAvailable().

roffset

size_t HelperServerBase::roffset

inherited

Definition at line 213 of file helper.h.

Referenced by helperHandleRead(), helperOpenServers(), helperStatefulHandleRead(), helperStatefulOpenServers(), and helper::packStatsInto().

struct { ... } HelperServerBase::stats

Referenced by helper_server::checkForTimedOutRequests(), clearReservation(), GetFirstAvailable(), helper::handleKilledServer(), helperDispatch(), helperHandleRead(), helperReturnBuffer(), helperShutdown(), helperStatefulDispatch(), helperStatefulHandleRead(), helperStatefulServerDone(), helperStatefulShutdown(), HelperServerBase::initStats(), helper::packStatsInto(), and StatefulGetFirstAvailable().

timedout

uint64_t HelperServerBase::timedout

inherited

Definition at line 234 of file helper.h.

Referenced by helperHandleRead(), and helper::packStatsInto().

uses

uint64_t HelperServerBase::uses

inherited

Definition at line 230 of file helper.h.

Referenced by helperDispatch(), helperStatefulDispatch(), and helper::packStatsInto().

writePipe

Comm::ConnectionPointer HelperServerBase::writePipe

inherited

Definition at line 208 of file helper.h.

Referenced by helper_server::~helper_server(), ~helper_stateful_server(), HelperServerBase::closePipesSafely(), HelperServerBase::closeWritePipeSafely(), helperDispatch(), helperDispatchWriteDone(), helperOpenServers(), helperStatefulDispatch(), and helperStatefulOpenServers().

---

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

• src/helper.h
• src/helper.cc