#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...
virtual void * toCbdata ()=0

Static Public Member Functions

static void HandleRemoteAck (unsigned int requestId)
 finds and calls the right Forwarder upon Coordinator's response More...
static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...

Protected Types

typedef std::map< unsigned int, 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...
const InstanceId< AsyncJobid
 job identifier More...

Static Protected Attributes

static RequestsMap TheRequestsMap
 pending Coordinator requests More...
static unsigned int 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 (unsigned int requestId)
 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<unsigned int, AsyncCall::Pointer> Ipc::Forwarder::RequestsMap

Definition at line 66 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 ( )

◆ callException()

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

Reimplemented from AsyncJob.

Definition at line 136 of file Forwarder.cc.

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

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 101 of file AsyncJob.cc.

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


Snmp::Forwarder::CBDATA_CLASS ( Forwarder  )

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)

◆ DequeueRequest()

AsyncCall::Pointer Ipc::Forwarder::DequeueRequest ( unsigned int  requestId)

Definition at line 148 of file Forwarder.cc.

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

◆ done()

bool AsyncJob::done ( ) const

◆ doneAll()

bool Ipc::Forwarder::doneAll ( ) const

Reimplemented from AsyncJob.

Definition at line 78 of file Forwarder.cc.

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

◆ handleError()

void Ipc::Forwarder::handleError ( )

Reimplemented in Mgr::Forwarder.

Definition at line 116 of file Forwarder.cc.

◆ handleException()

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

Reimplemented from Ipc::Forwarder.

Definition at line 68 of file Forwarder.cc.

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

◆ handleRemoteAck()

void Ipc::Forwarder::handleRemoteAck ( )

Definition at line 86 of file Forwarder.cc.

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

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

◆ HandleRemoteAck()

void Ipc::Forwarder::HandleRemoteAck ( unsigned int  requestId)

◆ handleTimeout()

void Snmp::Forwarder::handleTimeout ( )

Reimplemented from Ipc::Forwarder.

Definition at line 61 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, HERE(), and Must.

Referenced by Forwarder().

◆ removeTimeoutEvent()

void Ipc::Forwarder::removeTimeoutEvent ( )

Definition at line 164 of file Forwarder.cc.

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

◆ requestTimedOut()

void Ipc::Forwarder::requestTimedOut ( )

Definition at line 109 of file Forwarder.cc.

References debugs, and HERE().

◆ RequestTimedOut()

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

Definition at line 98 of file Forwarder.cc.

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

Referenced by Ipc::Forwarder::removeTimeoutEvent(), and Ipc::Forwarder::start().

◆ sendError()

◆ start()

void Ipc::Forwarder::start ( )

◆ Start()

◆ status()

const char * AsyncJob::status ( ) const

◆ swanSong()

void Snmp::Forwarder::swanSong ( )

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

Definition at line 47 of file Forwarder.h.

Referenced by Forwarder().

◆ fd

int Snmp::Forwarder::fd

Definition at line 46 of file Forwarder.h.

Referenced by Forwarder().

◆ id

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

◆ LastRequestId

unsigned int Ipc::Forwarder::LastRequestId = 0

Definition at line 69 of file Forwarder.h.

◆ request

Request::Pointer Ipc::Forwarder::request

Definition at line 62 of file Forwarder.h.

◆ stopReason

const char* AsyncJob::stopReason

◆ TheRequestsMap

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

Definition at line 67 of file Forwarder.h.

◆ timeout

const double Ipc::Forwarder::timeout

Definition at line 63 of file Forwarder.h.

◆ typeName

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






Web Site Translations