#include <Forwarder.h>

Inheritance diagram for Snmp::Forwarder:
Collaboration diagram for Snmp::Forwarder:

Public Types

typedef CbcPointer< AsyncJobPointer

Public Member Functions

 Forwarder (const Pdu &aPdu, const Session &aSession, int aFd, const Ip::Address &anAddress)
void callException (const std::exception &e) override
 called when the job throws during an async call 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...
void handleStopRequest ()
 process external request to terminate now (i.e. during this async call) More...
virtual void * toCbdata ()=0

Static Public Member Functions

static void HandleRemoteAck (RequestId)
 finds and calls the right Forwarder upon Coordinator's response More...
static void Start (const Pointer &job)
static void RegisterWithCacheManager ()

Public Attributes

CodeContextPointer codeContext
const InstanceId< AsyncJobid
 job identifier More...

Protected Types

typedef std::map< RequestId::Index, AsyncCall::PointerRequestsMap
 maps request->id to Forwarder::handleRemoteAck callback More...

Protected Member Functions

void swanSong () override
 removes our cleanup handler of the client connection socket More...
void handleTimeout () override
void handleException (const std::exception &e) override
 terminate with an error More...
void start () override
 called by AsyncStart; do not call directly More...
bool doneAll () const override
 whether positive goal has been reached More...
virtual void handleError ()
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...

Static Protected Member Functions

static void ReportAllJobs (StoreEntry *)
 writes a cache manager report about all jobs existing in this worker More...

Protected Attributes

Request::Pointer request
const double timeout
 response wait timeout in seconds More...
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...
bool started_ = false
 Start() has finished successfully. More...
bool swanSang_ = false
 swanSong() was called More...

Static Protected Attributes

static RequestsMap TheRequestsMap
 pending Coordinator requests More...
static RequestId::Index LastRequestId = 0
 last requestId used More...

Private Member Functions

 CBDATA_CHILD (Forwarder)
void noteCommClosed (const CommCloseCbParams &params)
 called when the client socket gets closed by some external force More...
void sendError (int error)
 send error SNMP response More...
void requestTimedOut ()
 called when Coordinator fails to start processing the request [in time] More...
void removeTimeoutEvent ()
 called when we are no longer waiting for Coordinator to respond More...
void handleRemoteAck ()
 called when Coordinator starts processing the request More...
virtual void finalizedInCbdataChild ()=0
 hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

Static Private Member Functions

static void RequestTimedOut (void *param)
 Ipc::Forwarder::requestTimedOut wrapper. More...
static AsyncCall::Pointer DequeueRequest (RequestId::Index)
 returns and forgets the right Forwarder callback for the request More...

Private Attributes

int fd
 client connection descriptor More...
AsyncCall::Pointer closer
 comm_close handler for the connection More...

Detailed Description

Forwards a single client SNMP request to Coordinator. Waits for an ACK from Coordinator Send the data unit with an error response if forwarding fails.

Definition at line 28 of file Forwarder.h.

Member Typedef Documentation

◆ Pointer

Definition at line 34 of file AsyncJob.h.

◆ RequestsMap

typedef std::map<RequestId::Index, AsyncCall::Pointer> Ipc::Forwarder::RequestsMap

Definition at line 69 of file Forwarder.h.

Constructor & Destructor Documentation

◆ Forwarder()

Snmp::Forwarder::Forwarder ( const Pdu aPdu,
const Session aSession,
int  aFd,
const Ip::Address anAddress 

Definition at line 24 of file Forwarder.cc.

References asyncCall(), closer, comm_add_close_handler(), debugs, fd, Must, and noteCommClosed().

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )

◆ callException()

void Ipc::Forwarder::callException ( const std::exception &  e)

Reimplemented from AsyncJob.

Definition at line 139 of file Forwarder.cc.

References AsyncJob::callException(), DBG_CRITICAL, and debugs.

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 117 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, and AsyncJob::inCall.


Snmp::Forwarder::CBDATA_CHILD ( Forwarder  )



◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ DequeueRequest()

AsyncCall::Pointer Ipc::Forwarder::DequeueRequest ( RequestId::Index  requestId)

Definition at line 151 of file Forwarder.cc.

References debugs, Must, and MYNAME.

◆ done()

bool AsyncJob::done ( ) const

◆ doneAll()

bool Ipc::Forwarder::doneAll ( ) const

Reimplemented from AsyncJob.

Definition at line 78 of file Forwarder.cc.

References debugs, and MYNAME.

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )
privatepure virtualinherited

◆ handleError()

void Ipc::Forwarder::handleError ( )

Reimplemented in Mgr::Forwarder.

Definition at line 119 of file Forwarder.cc.

◆ handleException()

void Snmp::Forwarder::handleException ( const std::exception &  e)

Reimplemented from Ipc::Forwarder.

Definition at line 69 of file Forwarder.cc.

References debugs, Ipc::Forwarder::handleException(), and SNMP_ERR_GENERR.

◆ handleRemoteAck()

void Ipc::Forwarder::handleRemoteAck ( )

Definition at line 86 of file Forwarder.cc.

References debugs, and MYNAME.

Referenced by Ipc::Forwarder::start().

◆ HandleRemoteAck()

void Ipc::Forwarder::HandleRemoteAck ( RequestId  requestId)

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

Definition at line 73 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ handleTimeout()

void Snmp::Forwarder::handleTimeout ( )

Reimplemented from Ipc::Forwarder.

Definition at line 62 of file Forwarder.cc.

References Ipc::Forwarder::handleTimeout(), and SNMP_ERR_RESOURCEUNAVAILABLE.

◆ mustStop()

◆ noteCommClosed()

void Snmp::Forwarder::noteCommClosed ( const CommCloseCbParams params)

Definition at line 52 of file Forwarder.cc.

References debugs, CommCommonCbParams::fd, Must, and MYNAME.

Referenced by Forwarder().

◆ RegisterWithCacheManager()

void AsyncJob::RegisterWithCacheManager ( )

Definition at line 215 of file AsyncJob.cc.

References Mgr::RegisterAction(), and AsyncJob::ReportAllJobs().

Referenced by mainInitialize().

◆ removeTimeoutEvent()

void Ipc::Forwarder::removeTimeoutEvent ( )

Definition at line 167 of file Forwarder.cc.

References eventDelete(), eventFind(), and Ipc::Forwarder::RequestTimedOut().

◆ ReportAllJobs()

void AsyncJob::ReportAllJobs ( StoreEntry e)

Definition at line 198 of file AsyncJob.cc.

References AllJobs().

Referenced by AsyncJob::RegisterWithCacheManager().

◆ requestTimedOut()

void Ipc::Forwarder::requestTimedOut ( )

Definition at line 112 of file Forwarder.cc.

References debugs, and MYNAME.

◆ RequestTimedOut()

void Ipc::Forwarder::RequestTimedOut ( void *  param)

◆ sendError()

◆ start()

void Ipc::Forwarder::start ( )

◆ Start()

◆ status()

◆ swanSong()

void Snmp::Forwarder::swanSong ( )

Reimplemented from Ipc::Forwarder.

Definition at line 38 of file Forwarder.cc.

References comm_remove_close_handler(), and Ipc::Forwarder::swanSong().

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ closer

AsyncCall::Pointer Snmp::Forwarder::closer

Definition at line 48 of file Forwarder.h.

Referenced by Forwarder().

◆ codeContext

CodeContextPointer Ipc::Forwarder::codeContext

Definition at line 43 of file Forwarder.h.

Referenced by Ipc::Forwarder::RequestTimedOut().

◆ fd

int Snmp::Forwarder::fd

Definition at line 47 of file Forwarder.h.

Referenced by Forwarder().

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 75 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

◆ LastRequestId

Ipc::RequestId::Index Ipc::Forwarder::LastRequestId = 0

Definition at line 72 of file Forwarder.h.

◆ request

Request::Pointer Ipc::Forwarder::request

Definition at line 65 of file Forwarder.h.

◆ started_

bool AsyncJob::started_ = false

Definition at line 88 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stopReason

const char* AsyncJob::stopReason

◆ swanSang_

bool AsyncJob::swanSang_ = false

Definition at line 89 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ TheRequestsMap

Ipc::Forwarder::RequestsMap Ipc::Forwarder::TheRequestsMap

Definition at line 70 of file Forwarder.h.

◆ timeout

const double Ipc::Forwarder::timeout

Definition at line 66 of file Forwarder.h.

◆ typeName

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






Web Site Translations