The base class for browser and server nodes. More...

#include <HttpNodeBase.h>

Inheritance diagram for inet::httptools::HttpNodeBase:

Public Member Functions
	HttpNodeBase ()

virtual void	initialize (int stage) override

virtual int	numInitStages () const override

Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
void	sendDirectToModule (HttpNodeBase receiver, cPacket packet, simtime_t constdelay=0.0, rdObject *rd=nullptr)

double	transmissionDelay (cPacket *packet)

void	logRequest (const HttpRequestMessage *httpRequest)

void	logResponse (const HttpReplyMessage *httpResponse)

void	logEntry (std::string line)

std::string	formatHttpRequestShort (const HttpRequestMessage *httpRequest)

std::string	formatHttpResponseShort (const HttpReplyMessage *httpResponse)

std::string	formatHttpRequestLong (const HttpRequestMessage *httpRequest)

std::string	formatHttpResponseLong (const HttpReplyMessage *httpResponse)

virtual bool	handleOperationStage (LifecycleOperation operation, int stage, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

Protected Attributes
unsigned long	linkSpeed = 0

int	httpProtocol = 0

std::string	logFileName

bool	enableLogging = true

LOG_FORMAT	outputFormat = lf_short

bool	m_bDisplayMessage = true

bool	m_bDisplayResponseContent = true

cModule *	host = nullptr

Detailed Description

The base class for browser and server nodes.

See the derived classes HttpBrowserBase and HttpServerBase for details

See also: HttpBrowserBase; HttpServerBase

Author: Kristjan V. Jonsson (krist.nosp@m.janv.nosp@m.j@gma.nosp@m.il.c.nosp@m.om)

Constructor & Destructor Documentation

inet::httptools::HttpNodeBase::HttpNodeBase ( )

 {
     m_bDisplayMessage = false;
     m_bDisplayResponseContent = false;
 }

Member Function Documentation

std::string inet::httptools::HttpNodeBase::formatHttpRequestLong ( const HttpRequestMessage * httpRequest )

protected

Referenced by logRequest().

 {
     std::ostringstream str;
 
     str << "REQUEST: " << httpRequest->getName() << " -- " << httpRequest->getByteLength() << " bytes\n";
     str << "Target URL:" << httpRequest->targetUrl() << "  Originator URL:" << httpRequest->originatorUrl() << endl;
 
     str << "PROTOCOL:";
     switch (httpRequest->protocol()) {    // MIGRATE40: kvj
         case 10:
             str << "HTTP/1.0";
             break;
 
         case 11:
             str << "HTTP/1.1";
             break;
 
         default:
             str << "UNKNOWN";
             break;
     }
     str << "  ";
 
     str << "KEEP-ALIVE:" << httpRequest->keepAlive() << "  ";
     str << "BAD-REQ:" << httpRequest->badRequest() << "  ";
     str << "SERIAL:" << httpRequest->serial() << "  " << endl;
 
     str << "REQUEST:" << httpRequest->heading() << endl;
 
     return str.str();
 }

std::string inet::httptools::HttpNodeBase::formatHttpRequestShort ( const HttpRequestMessage * httpRequest )

protected

Referenced by logRequest().

 {
     std::ostringstream str;
 
     std::string originatorStr = "";
     cModule *originator = findContainingNode(httpRequest->getSenderModule());
     if (originator != nullptr)
         originatorStr = originator->getFullName();
 
     str << originatorStr << ";";
     str << "REQ;" << httpRequest->originatorUrl() << ";" << httpRequest->targetUrl() << ";";
     str << httpRequest->protocol() << ";" << httpRequest->keepAlive() << ";" << httpRequest->serial() << ";";
     str << httpRequest->heading() << ";" << httpRequest->badRequest() << ";;";    // Skip the response specific fields
 
     return str.str();
 }

std::string inet::httptools::HttpNodeBase::formatHttpResponseLong ( const HttpReplyMessage * httpResponse )

protected

Referenced by logResponse().

 {
     std::ostringstream str;
 
     str << "RESPONSE: " << httpResponse->getName() << " -- " << httpResponse->getByteLength() << " bytes\n";
 
     str << "Target URL:" << httpResponse->targetUrl() << "  Originator URL:" << httpResponse->originatorUrl() << endl;
 
     str << "PROTOCOL:";
     switch (httpResponse->protocol()) {
         case 10:
             str << "HTTP/1.0";
             break;
 
         case 11:
             str << "HTTP/1.1";
             break;
 
         default:
             str << "UNKNOWN";
             break;
     }
     str << "  ";
 
     str << "RESULT:" << httpResponse->result() << "  ";
     str << "KEEP-ALIVE:" << httpResponse->keepAlive() << "  ";
     str << "SERIAL:" << httpResponse->serial() << "  " << endl;
 
     str << "RESPONSE: " << httpResponse->heading() << endl;
 
     str << "CONTENT-TYPE:";
     switch (httpResponse->contentType()) {
         case CT_HTML:
             str << "HTML DOC";
             break;
 
         case CT_TEXT:
             str << "Text/HTML RES";
             break;
 
         case CT_IMAGE:
             str << "IMG RES";
             break;
 
         default:
             str << "UNKNOWN";
             break;
     }
     str << endl;
 
     if (m_bDisplayResponseContent) {
         str << "CONTENT:" << endl;
         str << httpResponse->payload() << endl;
     }
 
     return str.str();
 }

std::string inet::httptools::HttpNodeBase::formatHttpResponseShort ( const HttpReplyMessage * httpResponse )

protected

Referenced by logResponse().

 {
     std::ostringstream str;
 
     std::string originatorStr = "";
     cModule *originator = findContainingNode(httpResponse->getSenderModule());
     if (originator != nullptr)
         originatorStr = originator->getFullName();
 
     str << originatorStr << ";";
     str << "RESP;" << httpResponse->originatorUrl() << ";" << httpResponse->targetUrl() << ";";
     str << httpResponse->protocol() << ";" << httpResponse->keepAlive() << ";" << httpResponse->serial() << ";";
     str << httpResponse->heading() << ";;";    // Skip the request specific fields
     str << httpResponse->result() << ";" << httpResponse->contentType();
 
     return str.str();
 }

virtual bool inet::httptools::HttpNodeBase::handleOperationStage	(	LifecycleOperation *	operation,
		int	stage,
		IDoneCallback *	doneCallback
	)

inlineoverrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

95 { Enter_Method_Silent(); throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName()); return true; }

void inet::httptools::HttpNodeBase::initialize ( int stage )

overridevirtual

Reimplemented in inet::httptools::HttpBrowserBase, inet::httptools::HttpServerBase, inet::httptools::HttpBrowser, inet::httptools::HttpServer, inet::httptools::HttpServerDirectEvilA, inet::httptools::HttpServerDirectEvilB, inet::httptools::HttpServerEvilA, inet::httptools::HttpServerEvilB, inet::httptools::HttpServerDirect, and inet::httptools::HttpBrowserDirect.

Referenced by inet::httptools::HttpServerBase::initialize(), and inet::httptools::HttpBrowserBase::initialize().

 {
     EV_DEBUG << "Initializing base HTTP browser component -- stage " << stage << endl;
 
     cSimpleModule::initialize(stage);
 
     if (stage == INITSTAGE_LOCAL) {
         host = getContainingNode(this);
     }
 }

void inet::httptools::HttpNodeBase::logEntry ( std::string line )

protected

Referenced by logRequest(), and logResponse().

 {
     if (!enableLogging || logFileName.empty())
         return;
 
     std::ofstream outfile;
     time_t curtime;
     time(&curtime);
 
     outfile.open(logFileName.c_str(), std::ios::app);
     if (outfile.tellp() == 0)
         outfile << "time;simtime;logging-node;sending-node;type;originator-url;target-url;protocol;keep-alive;serial;heading;bad-req;result-code;content-type" << endl;
     outfile << curtime << ";" << simTime() << ";" << host->getName();
     if (outputFormat == lf_short)
         outfile << ";";
     else
         outfile << endl;
     outfile << line << endl;
     outfile.close();
 }

void inet::httptools::HttpNodeBase::logRequest ( const HttpRequestMessage * httpRequest )

protected

Referenced by inet::httptools::HttpBrowserBase::generatePageRequest(), inet::httptools::HttpBrowserBase::generateResourceRequest(), and inet::httptools::HttpServerBase::handleReceivedMessage().

 {
     if (!enableLogging)
         return;
     if (outputFormat == lf_short)
         logEntry(formatHttpRequestShort(httpRequest));
     else
         logEntry(formatHttpRequestLong(httpRequest));
     if (m_bDisplayMessage)
         EV_INFO << "Request:\n" << formatHttpRequestLong(httpRequest);
 }

void inet::httptools::HttpNodeBase::logResponse ( const HttpReplyMessage * httpResponse )

protected

Referenced by inet::httptools::HttpBrowserBase::handleDataMessage(), and inet::httptools::HttpServerBase::handleReceivedMessage().

 {
     if (!enableLogging)
         return;
     if (outputFormat == lf_short)
         logEntry(formatHttpResponseShort(httpResponse));
     else
         logEntry(formatHttpResponseLong(httpResponse));
     if (m_bDisplayMessage)
         EV_INFO << "Response:\n" << formatHttpResponseLong(httpResponse);
 }

virtual int inet::httptools::HttpNodeBase::numInitStages ( ) const

inlineoverridevirtual

Reimplemented in inet::httptools::HttpBrowserBase, inet::httptools::HttpServerBase, inet::httptools::HttpBrowser, inet::httptools::HttpServer, inet::httptools::HttpServerDirectEvilA, inet::httptools::HttpServerDirectEvilB, inet::httptools::HttpServerEvilA, inet::httptools::HttpServerEvilB, inet::httptools::HttpBrowserDirect, and inet::httptools::HttpServerDirect.

100 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

void inet::httptools::HttpNodeBase::sendDirectToModule	(	HttpNodeBase *	receiver,
		cPacket *	packet,
		simtime_t	constdelay = `0.0`,
		rdObject *	rd = `nullptr`
	)

protected

Referenced by inet::httptools::HttpServerDirect::handleMessage(), inet::httptools::HttpBrowserDirect::sendRequestsToServer(), inet::httptools::HttpBrowserDirect::sendRequestToRandomServer(), and inet::httptools::HttpBrowserDirect::sendRequestToServer().

 {
     if (pckt == nullptr)
         return;
     simtime_t delay = constdelay + transmissionDelay(pckt);
     if (rdDelay != nullptr)
         delay += rdDelay->draw();
     EV_DEBUG << "Sending " << pckt->getName() << " direct to " << getContainingNode(receiver)->getName() << " with a delay of " << delay << " s\n";
     sendDirect(pckt, delay, 0, receiver, "httpIn");
 }

double inet::httptools::HttpNodeBase::transmissionDelay ( cPacket * packet )

protected

Referenced by sendDirectToModule().

 {
     if (linkSpeed == 0)
         return 0.0; // No delay if link speed unspecified
     return pckt->getBitLength() / ((double)linkSpeed);    // The link speed is in bit/s
 }