#include <HttpServer.h>

Inheritance diagram for inet::httptools::HttpServer:

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	finish () override

virtual void	handleMessage (cMessage *msg) override

virtual void	socketEstablished (int connId, void *yourPtr) override

virtual void	socketDataArrived (int connId, void yourPtr, cPacket msg, bool urgent) override

virtual void	socketPeerClosed (int connId, void *yourPtr) override

virtual void	socketClosed (int connId, void *yourPtr) override

virtual void	socketFailure (int connId, void *yourPtr, int code) override

Protected Member Functions inherited from inet::httptools::HttpServerBase
virtual void	refreshDisplay () const override

HttpReplyMessage *	generateDocument (HttpRequestMessage request, const char resource, int size=0)

HttpReplyMessage *	generateResourceMessage (HttpRequestMessage *request, std::string resource, HttpContentType category)

HttpReplyMessage *	handleGetRequest (HttpRequestMessage *request, std::string resource)

HttpReplyMessage *	generateErrorReply (HttpRequestMessage *request, int code)

virtual std::string	generateBody ()

cPacket *	handleReceivedMessage (cMessage *msg)

void	registerWithController ()

void	readSiteDefinition (std::string file)

std::string	readHtmlBodyFile (std::string file, std::string path)

Protected Member Functions inherited from inet::httptools::HttpNodeBase
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
TCPSocket	listensocket

TCPSocketMap	sockCollection

unsigned long	numBroken = 0

unsigned long	socketsOpened = 0

Protected Attributes inherited from inet::httptools::HttpServerBase
std::string	hostName

int	port = -1

bool	scriptedMode = false

std::map< std::string, HtmlPageData >	htmlPages

std::map< std::string, unsigned int >	resources

simtime_t	activationTime

long	htmlDocsServed = 0

long	imgResourcesServed = 0

long	textResourcesServed = 0

long	badRequests = 0

rdObject *	rdReplyDelay = nullptr
	The processing delay of the server. More...

rdObject *	rdHtmlPageSize = nullptr
	The HTML page size distribution for the site. More...

rdObject *	rdTextResourceSize = nullptr
	The text resource size distribution for the site. More...

rdObject *	rdImageResourceSize = nullptr
	The image resource size distribution for the site. More...

rdObject *	rdNumResources = nullptr
	Number of resources per HTML page. More...

rdObject *	rdTextImageResourceRatio = nullptr
	The ratio of text resources to images referenced in HTML pages. More...

rdObject *	rdErrorMsgSize = nullptr
	The size of error messages. More...

Protected Attributes inherited from inet::httptools::HttpNodeBase
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

Additional Inherited Members
Public Member Functions inherited from inet::httptools::HttpServerBase
	HttpServerBase ()

	~HttpServerBase ()

const std::string &	getHostName ()

Public Member Functions inherited from inet::httptools::HttpNodeBase
	HttpNodeBase ()

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

Public Member Functions inherited from inet::TCPSocket::CallbackInterface
virtual	~CallbackInterface ()

virtual void	socketStatusArrived (int connId, void yourPtr, TCPStatusInfo status)

virtual void	socketDeleted (int connId, void *yourPtr)

Detailed Description

HttpServerDirect module.

This module implements a flexible Web server. It is part of the HttpTools project and should be used in conjunction with a number of clients running the HttpBrowserDirect.

See also: HttpBrowserDirect

Author: Kristjan V. Jonsson

Member Function Documentation

void inet::httptools::HttpServer::finish ( )

overrideprotectedvirtual

Reimplemented from inet::httptools::HttpServerBase.

 {
     HttpServerBase::finish();
 
     EV_INFO << "Sockets opened: " << socketsOpened << endl;
     EV_INFO << "Broken connections: " << numBroken << endl;
 
     recordScalar("sock.opened", socketsOpened);
     recordScalar("sock.broken", numBroken);
 
     // Clean up sockets and data structures
     sockCollection.deleteSockets();
 }

void inet::httptools::HttpServer::handleMessage ( cMessage * msg )

overrideprotectedvirtual

Implements inet::httptools::HttpServerBase.

 {
     if (msg->isSelfMessage()) {
         // Self messages not used at the moment
     }
     else {
         EV_DEBUG << "Handle inbound message " << msg->getName() << " of kind " << msg->getKind() << endl;
         TCPSocket *socket = sockCollection.findSocketFor(msg);
         if (!socket) {
             EV_DEBUG << "No socket found for the message. Create a new one" << endl;
             // new connection -- create new socket object and server process
             socket = new TCPSocket(msg);
             socket->setOutputGate(gate("tcpOut"));
             socket->setDataTransferMode(TCP_TRANSFER_OBJECT);
             socket->setCallbackObject(this, socket);
             sockCollection.addSocket(socket);
         }
         EV_DEBUG << "Process the message " << msg->getName() << endl;
         socket->processMessage(msg);
     }
 }

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

overrideprotectedvirtual

Reimplemented from inet::httptools::HttpServerBase.

Reimplemented in inet::httptools::HttpServerEvilA, and inet::httptools::HttpServerEvilB.

Referenced by inet::httptools::HttpServerEvilA::initialize(), and inet::httptools::HttpServerEvilB::initialize().

 {
     HttpServerBase::initialize(stage);
 
     if (stage == INITSTAGE_LOCAL) {
         numBroken = 0;
         socketsOpened = 0;
 
         WATCH(numBroken);
         WATCH(socketsOpened);
     }
     else if (stage == INITSTAGE_APPLICATION_LAYER) {
         EV_DEBUG << "Initializing server component (sockets version)" << endl;
 
         int port = par("port");
 
         TCPSocket listensocket;
         listensocket.setOutputGate(gate("tcpOut"));
         listensocket.setDataTransferMode(TCP_TRANSFER_OBJECT);
         listensocket.bind(port);
         listensocket.setCallbackObject(this);
         listensocket.listen();
     }
 }

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

inlineoverrideprotectedvirtual

Reimplemented from inet::httptools::HttpServerBase.

Reimplemented in inet::httptools::HttpServerEvilA, and inet::httptools::HttpServerEvilB.

48 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

void inet::httptools::HttpServer::socketClosed	(	int	connId,
		void *	yourPtr
	)

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

 {
     EV_INFO << "connection closed. Connection id " << connId << endl;
 
     if (yourPtr == nullptr) {
         EV_ERROR << "Socket establish failure. Null pointer" << endl;
         return;
     }
     // Cleanup
     TCPSocket *socket = (TCPSocket *)yourPtr;
     sockCollection.removeSocket(socket);
     delete socket;
 }

void inet::httptools::HttpServer::socketDataArrived	(	int	connId,
		void *	yourPtr,
		cPacket *	msg,
		bool	urgent
	)

overrideprotectedvirtual

Implements inet::TCPSocket::CallbackInterface.

 {
     if (yourPtr == nullptr) {
         EV_ERROR << "Socket establish failure. Null pointer" << endl;
         return;
     }
     TCPSocket *socket = (TCPSocket *)yourPtr;
 
     // Should be a HttpReplyMessage
     EV_DEBUG << "Socket data arrived on connection " << connId << ". Message=" << msg->getName() << ", kind=" << msg->getKind() << endl;
 
     // call the message handler to process the message.
     cMessage *reply = handleReceivedMessage(msg);
     if (reply != nullptr) {
         socket->send(reply);    // Send to socket if the reply is non-zero.
     }
     delete msg;    // Delete the received message here. Must not be deleted in the handler!
 }

void inet::httptools::HttpServer::socketEstablished	(	int	connId,
		void *	yourPtr
	)

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

 {
     EV_INFO << "connected socket with id=" << connId << endl;
     socketsOpened++;
 }

void inet::httptools::HttpServer::socketFailure	(	int	connId,
		void *	yourPtr,
		int	code
	)

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

 {
     EV_WARN << "connection broken. Connection id " << connId << endl;
     numBroken++;
 
     EV_INFO << "connection closed. Connection id " << connId << endl;
 
     if (yourPtr == nullptr) {
         EV_ERROR << "Socket establish failure. Null pointer" << endl;
         return;
     }
     TCPSocket *socket = (TCPSocket *)yourPtr;
 
     if (code == TCP_I_CONNECTION_RESET)
         EV_WARN << "Connection reset!\n";
     else if (code == TCP_I_CONNECTION_REFUSED)
         EV_WARN << "Connection refused!\n";
 
     // Cleanup
     sockCollection.removeSocket(socket);
     delete socket;
 }

void inet::httptools::HttpServer::socketPeerClosed	(	int	connId,
		void *	yourPtr
	)

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

 {
     if (yourPtr == nullptr) {
         EV_ERROR << "Socket establish failure. Null pointer" << endl;
         return;
     }
     TCPSocket *socket = (TCPSocket *)yourPtr;
 
     // close the connection (if not already closed)
     if (socket->getState() == TCPSocket::PEER_CLOSED) {
         EV_INFO << "remote TCP closed, closing here as well. Connection id is " << connId << endl;
         socket->close();    // Call the close method to properly dispose of the socket.
     }
 }