#include <helper.h>

Inheritance diagram for statefulhelper:

Collaboration diagram for statefulhelper:

[legend]

Public Types
typedef std::unordered_map< Helper::ReservationId, helper_stateful_server * >	Reservations

Public Member Functions
void *	operator new (size_t size)

void	operator delete (void *address)

void *	toCbdata () noexcept

	statefulhelper (const char *name)

	~statefulhelper ()

void	reserveServer (helper_stateful_server *srv)
	reserve the given server More...

void	cancelReservation (const Helper::ReservationId reservation)
	undo reserveServer(), clear the reservation and kick the queue More...

Helper::Xaction *	nextRequest ()

bool	trySubmit (const char buf, HLPCB callback, void *data)
	If possible, submit request. Otherwise, either kill Squid or return false. More...

void	submitRequest (Helper::Xaction *r)

void	packStatsInto (Packable p, const char label=nullptr) const
	Dump some stats about the helper state to a Packable object. More...

bool	willOverload () const

void	handleKilledServer (HelperServerBase *srv, bool &needsNewServers)

Public Attributes
wordlist *	cmdline

dlink_list	servers

std::queue< Helper::Xaction * >	queue

const char *	id_name

Helper::ChildConfig	childs
	Configuration settings for number running. More...

int	ipc_type

Ip::Address	addr

unsigned int	droppedRequests
	requests not sent during helper overload More...

time_t	overloadStart
	when the helper became overloaded (zero if it is not) More...

time_t	last_queue_warn

time_t	last_restart

time_t	timeout
	Requests timeout. More...

bool	retryTimedOut
	Whether the timed-out requests must retried. More...

bool	retryBrokenHelper
	Whether the requests must retried on BH replies. More...

SBuf	onTimedOutResponse
	The response to use when helper response timedout. More...

char	eom
	The char which marks the end of (response) message, normally ' '. More...

struct helper::_stats	stats

Protected Member Functions
bool	queueFull () const
	whether queuing an additional request would overload the helper More...

bool	overloaded () const

void	syncQueueStats ()
	synchronizes queue-dependent measurements with the current queue state More...

bool	prepSubmit ()

void	submit (const char buf, HLPCB callback, void *data)
	dispatches or enqueues a helper requests; does not enforce queue limits More...

Private Member Functions
helper_stateful_server *	findServer (const Helper::ReservationId &reservation)

void	submit (const char buf, HLPCB callback, void *data, const Helper::ReservationId &reservation)

bool	trySubmit (const char buf, HLPCB callback, void *data, const Helper::ReservationId &reservation)
	reserved servers indexed by reservation IDs More...

Private Attributes
Reservations	reservations

Static Private Attributes
static cbdata_type	CBDATA_statefulhelper = CBDATA_UNKNOWN

static cbdata_type	CBDATA_helper = CBDATA_UNKNOWN

Friends
void	helperStatefulSubmit (statefulhelper hlp, const char buf, HLPCB callback, void data, const Helper::ReservationId &reservation)

Detailed Description

Definition at line 141 of file helper.h.

Member Typedef Documentation

◆ Reservations

typedef std::unordered_map<Helper::ReservationId, helper_stateful_server *> statefulhelper::Reservations

Definition at line 146 of file helper.h.

Constructor & Destructor Documentation

◆ statefulhelper()

statefulhelper::statefulhelper ( const char * name )

inline

Definition at line 148 of file helper.h.

◆ ~statefulhelper()

statefulhelper::~statefulhelper ( )

inline

Definition at line 149 of file helper.h.

Member Function Documentation

◆ cancelReservation()

void statefulhelper::cancelReservation ( const Helper::ReservationId reservation )

Definition at line 598 of file helper.cc.

References asyncCall(), cbdataDialer(), helper_stateful_server::clearReservation(), helperStatefulServerDone(), reservations, and ScheduleCallHere.

Referenced by helper_stateful_server::~helper_stateful_server(), helperStatefulDispatch(), and helperStatefulHandleRead().

◆ findServer()

helper_stateful_server * statefulhelper::findServer ( const Helper::ReservationId & reservation )

private

Returns: the previously reserved server (if the reservation is still valid) or nil

Definition at line 614 of file helper.cc.

References reservations.

Referenced by submit().

◆ handleKilledServer()

void helper::handleKilledServer	(	HelperServerBase *	srv,
		bool &	needsNewServers
	)

inherited

Updates interall statistics and start new helper server processes after an unexpected server exit

Parameters

needsNewServers true if new servers must started, false otherwise

Definition at line 833 of file helper.cc.

References assert, helper::childs, DBG_CRITICAL, DBG_IMPORTANT, debugs, fatalf(), HelperServerBase::flags, helper::id_name, HelperServerBase::index, helper::last_restart, Helper::ChildConfig::n_active, Helper::ChildConfig::n_max, Helper::ChildConfig::n_startup, Helper::ChildConfig::needNew(), HelperServerBase::replies, HelperServerBase::_helper_flags::shutdown, squid_curtime, and HelperServerBase::stats.

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

◆ nextRequest()

Helper::Xaction * helper::nextRequest ( )

inherited

Returns: next request in the queue, or nil.

Definition at line 1261 of file helper.cc.

References helper::queue, helper::_stats::queue_size, and helper::stats.

Referenced by helperKickQueue(), and helperStatefulKickQueue().

◆ operator delete()

void statefulhelper::operator delete ( void * address )

inline

Definition at line 143 of file helper.h.

◆ operator new()

void * statefulhelper::operator new ( size_t size )

inline

Definition at line 143 of file helper.h.

◆ overloaded()

bool helper::overloaded ( ) const

protectedinherited

Definition at line 486 of file helper.cc.

References helper::childs, helper::_stats::queue_size, Helper::ChildConfig::queue_size, and helper::stats.

Referenced by helper::prepSubmit(), and helper::syncQueueStats().

◆ packStatsInto()

void helper::packStatsInto	(	Packable *	p,
		const char *	label = `nullptr`
	)		const

inherited

Definition at line 677 of file helper.cc.

Referenced by authenticateBasicStats(), authenticateDigestStats(), authenticateNegotiateStats(), authenticateNTLMStats(), redirectStats(), and storeIdStats().

◆ prepSubmit()

bool helper::prepSubmit ( )

protectedinherited

prepares the helper for request submission returns true if and only if the submission should proceed may kill Squid if the helper remains overloaded for too long

Definition at line 519 of file helper.cc.

References Helper::ChildConfig::actDie, helper::childs, DBG_IMPORTANT, debugs, helper::droppedRequests, fatalf(), helper::id_name, Helper::ChildConfig::onPersistentOverload, helper::overloaded(), helper::overloadStart, squid_curtime, and helper::syncQueueStats().