#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)
 
virtual void callException (const std::exception &e)
 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)
 

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

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

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_CLASS (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...
 

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 27 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
protectedinherited

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, HERE(), Must, and noteCommClosed().

Member Function Documentation

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

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

Reimplemented from AsyncJob.

Definition at line 141 of file Forwarder.cc.

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 102 of file AsyncJob.cc.

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

◆ CBDATA_CLASS()

Snmp::Forwarder::CBDATA_CLASS ( Forwarder  )
private

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ DequeueRequest()

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

Definition at line 153 of file Forwarder.cc.

References debugs, HERE(), Must, NULL, and request().

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

bool Ipc::Forwarder::doneAll ( ) const
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 80 of file Forwarder.cc.

References debugs, HERE(), and request().

◆ handleError()

void Ipc::Forwarder::handleError ( )
protectedvirtualinherited

Reimplemented in Mgr::Forwarder.

Definition at line 121 of file Forwarder.cc.

◆ handleException()

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

Reimplemented from Ipc::Forwarder.

Definition at line 69 of file Forwarder.cc.

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

◆ handleRemoteAck()

void Ipc::Forwarder::handleRemoteAck ( )
privateinherited

Definition at line 88 of file Forwarder.cc.

References debugs, HERE(), and request().

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

◆ HandleRemoteAck()

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

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )
inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ handleTimeout()

void Snmp::Forwarder::handleTimeout ( )
protectedvirtual

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)
private

Definition at line 52 of file Forwarder.cc.

References debugs, CommCommonCbParams::fd, HERE(), and Must.

Referenced by Forwarder().

◆ removeTimeoutEvent()

void Ipc::Forwarder::removeTimeoutEvent ( )
privateinherited

Definition at line 169 of file Forwarder.cc.

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

◆ requestTimedOut()

void Ipc::Forwarder::requestTimedOut ( )
privateinherited

Definition at line 114 of file Forwarder.cc.

References debugs, and HERE().

◆ RequestTimedOut()

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

◆ sendError()

◆ start()

void Ipc::Forwarder::start ( )
protectedvirtualinherited

◆ Start()

◆ status()

◆ swanSong()

void Snmp::Forwarder::swanSong ( )
protectedvirtual

Reimplemented from Ipc::Forwarder.

Definition at line 38 of file Forwarder.cc.

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

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ closer

AsyncCall::Pointer Snmp::Forwarder::closer
private

Definition at line 47 of file Forwarder.h.

Referenced by Forwarder().

◆ codeContext

CodeContextPointer Ipc::Forwarder::codeContext
inherited

Definition at line 43 of file Forwarder.h.

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

◆ fd

int Snmp::Forwarder::fd
private

Definition at line 46 of file Forwarder.h.

Referenced by Forwarder().

◆ id

const InstanceId<AsyncJob> AsyncJob::id
inherited

Definition at line 73 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

◆ LastRequestId

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

Definition at line 72 of file Forwarder.h.

◆ request

Request::Pointer Ipc::Forwarder::request
protectedinherited

Definition at line 65 of file Forwarder.h.

◆ started_

bool AsyncJob::started_ = false
protectedinherited

Definition at line 83 of file AsyncJob.h.

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

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ swanSang_

bool AsyncJob::swanSang_ = false
protectedinherited

Definition at line 84 of file AsyncJob.h.

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

◆ TheRequestsMap

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

Definition at line 70 of file Forwarder.h.

◆ timeout

const double Ipc::Forwarder::timeout
protectedinherited

Definition at line 66 of file Forwarder.h.

◆ typeName


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors