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

#include <helper.h>

Inheritance diagram for helper_server:
Collaboration diagram for helper_server:

Public Types

typedef std::map< uint64_t, Requests::iterator > RequestIndex
 
typedef std::list< Helper::Xaction * > Requests
 

Public Member Functions

virtual ~helper_server ()
 
Helper::XactionpopRequest (int requestId)
 
void checkForTimedOutRequests (bool const retry)
 
virtual bool reserved () override
 whether the server is locked for exclusive use by a client More...
 
virtual void dropQueued () override
 dequeues and sends a Helper::Unknown answer to all queued requests More...
 
virtual helpergetParent () const override
 the helper object that created this server More...
 
void closePipesSafely (const char *name)
 
void closeWritePipeSafely (const char *name)
 
void initStats ()
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static void requestTimeout (const CommTimeoutCbParams &io)
 Read timeout handler. More...
 
static void HelperServerClosed (helper_server *srv)
 close handler to handle exited server processes More...
 

Public Attributes

uint64_t nextRequestId
 
MemBufwqueue
 
MemBufwritebuf
 
helperparent
 
Helper::XactionreplyXaction
 
bool ignoreToEom
 Whether to ignore current message, because it is timed-out or other reason. More...
 
RequestIndex requestsIndex
 maps request IDs to requests More...
 
const InstanceId< HelperServerBaseindex
 
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_server)
 

Detailed Description

Definition at line 243 of file helper.h.

Member Typedef Documentation

◆ RequestIndex

typedef std::map<uint64_t, Requests::iterator> helper_server::RequestIndex

Definition at line 265 of file helper.h.

◆ Requests

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

Definition at line 225 of file helper.h.

Constructor & Destructor Documentation

◆ ~helper_server()

Member Function Documentation

◆ CBDATA_CHILD()

helper_server::CBDATA_CHILD ( helper_server  )
private

◆ checkForTimedOutRequests()

void helper_server::checkForTimedOutRequests ( bool const  retry)

◆ 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
namedisplayed for the helper being shutdown if logging an error

Definition at line 73 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
namedisplayed for the helper being shutdown if logging an error

Definition at line 99 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 helperStatefulServerDone(), ~helper_server(), and helper_stateful_server::~helper_stateful_server().

◆ dropQueued()

void helper_server::dropQueued ( )
overridevirtual

Reimplemented from HelperServerBase.

Definition at line 171 of file helper.cc.

References HelperServerBase::dropQueued().

Referenced by HelperServerClosed().

◆ getParent()

virtual helper* helper_server::getParent ( ) const
inlineoverridevirtual

Implements HelperServerBase.

Definition at line 282 of file helper.h.

Referenced by HelperServerClosed().

◆ HelperServerClosed()

void helper_server::HelperServerClosed ( helper_server srv)
static

◆ initStats()

void HelperServerBase::initStats ( )
inherited

Definition at line 63 of file helper.cc.

References HelperServerBase::stats.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

◆ popRequest()

Helper::Xaction * helper_server::popRequest ( int  requestId)

Search in queue for the request with requestId, return the related Xaction object and remove it from queue. If concurrency is disabled then the requestId is ignored and the Xaction of the next request in queue is retrieved.

Definition at line 888 of file helper.cc.

References HelperServerBase::requests.

Referenced by helperHandleRead().

◆ requestTimeout()

◆ reserved()

virtual bool helper_server::reserved ( )
inlineoverridevirtual

Implements HelperServerBase.

Definition at line 280 of file helper.h.

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ addr

Ip::Address HelperServerBase::addr
inherited

Definition at line 205 of file helper.h.

Referenced by helperOpenServers(), and helperStatefulOpenServers().

◆ answer_time

struct timeval HelperServerBase::answer_time
inherited

Definition at line 215 of file helper.h.

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

◆ dispatch_time

struct timeval HelperServerBase::dispatch_time
inherited

◆ flags

◆ hIpc

void* HelperServerBase::hIpc
inherited

◆ ignoreToEom

bool helper_server::ignoreToEom

Definition at line 262 of file helper.h.

Referenced by helperHandleRead(), and helperOpenServers().

◆ index

◆ link

◆ nextRequestId

uint64_t helper_server::nextRequestId

Definition at line 248 of file helper.h.

Referenced by helperDispatch(), and helperOpenServers().

◆ parent

helper* helper_server::parent

◆ pending

◆ pid

◆ rbuf

char* HelperServerBase::rbuf
inherited

◆ rbuf_sz

◆ readPipe

◆ releases

uint64_t HelperServerBase::releases
inherited

Definition at line 232 of file helper.h.

◆ replies

uint64_t HelperServerBase::replies
inherited

◆ replyXaction

Helper::Xaction* helper_server::replyXaction

The helper request Xaction object for the current reply . A helper reply may be distributed to more than one of the retrieved packets from helper. This member stores the Xaction object as long as the end-of-message for current reply is not retrieved.

Definition at line 259 of file helper.h.

Referenced by helperHandleRead(), helperOpenServers(), and helperReturnBuffer().

◆ requests

◆ requestsIndex

RequestIndex helper_server::requestsIndex

Definition at line 266 of file helper.h.

Referenced by helperDispatch().

◆ roffset

size_t HelperServerBase::roffset
inherited

◆ stats

◆ timedout

uint64_t HelperServerBase::timedout
inherited

Definition at line 233 of file helper.h.

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

◆ uses

uint64_t HelperServerBase::uses
inherited

Definition at line 229 of file helper.h.

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

◆ wqueue

MemBuf* helper_server::wqueue

Definition at line 250 of file helper.h.

Referenced by helperDispatch(), helperDispatchWriteDone(), and helperOpenServers().

◆ writebuf

MemBuf* helper_server::writebuf

Definition at line 251 of file helper.h.

Referenced by helperDispatch(), and helperDispatchWriteDone().

◆ writePipe


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors