inet::httptools::HttpBrowser Class Reference

Browser module. More...

#include <HttpBrowser.h>

Inheritance diagram for inet::httptools::HttpBrowser:

Classes
struct	SockData

Public Member Functions
	HttpBrowser ()
virtual	~HttpBrowser ()
Public Member Functions inherited from inet::httptools::HttpBrowserBase
	HttpBrowserBase ()
virtual	~HttpBrowserBase ()
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 ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	finish () override
virtual void	handleMessage (cMessage *msg) override
int	numInitStages () const override
virtual void	sendRequestToServer (BrowseEvent be) override
virtual void	sendRequestToServer (HttpRequestMessage *request) override
virtual void	sendRequestToRandomServer () override
virtual void	sendRequestsToServer (std::string www, HttpRequestQueue queue) 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
virtual void	socketStatusArrived (int connId, void *yourPtr, TCPStatusInfo *status) override
virtual void	socketDeleted (int connId, void *yourPtr) override
void	submitToSocket (const char *moduleName, int connectPort, HttpRequestMessage *msg)
void	submitToSocket (const char *moduleName, int connectPort, HttpRequestQueue &queue)
	Establishes a socket and assigns a queue of messages to be transmitted. More...
Protected Member Functions inherited from inet::httptools::HttpBrowserBase
void	handleDataMessage (cMessage *msg)
void	handleSelfMessages (cMessage *msg)
void	handleSelfActivityStart ()
void	handleSelfStartSession ()
void	handleSelfNextMessage ()
void	handleSelfScriptedEvent ()
void	handleSelfDelayedRequestMessage (cMessage *msg)
void	scheduleNextBrowseEvent ()
HttpRequestMessage *	generatePageRequest (std::string www, std::string page, bool bad=false, int size=0)
HttpRequestMessage *	generateRandomPageRequest (std::string www, bool bad=false, int size=0)
HttpRequestMessage *	generateResourceRequest (std::string www, std::string resource="", int serial=0, bool bad=false, int size=0)
void	readScriptedEvents (const char *filename)
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
TCPSocketMap	sockCollection
unsigned long	numBroken = 0
unsigned long	socketsOpened = 0
Protected Attributes inherited from inet::httptools::HttpBrowserBase
cMessage *	eventTimer = nullptr
HttpController *	controller = nullptr
bool	scriptedMode = false
BrowseEventsList	browseEvents
int	reqInCurSession = 0
int	reqNoInCurSession = 0
simtime_t	acitivityPeriodEnd
rdObject *	rdProcessingDelay = nullptr
rdObject *	rdActivityLength = nullptr
rdObject *	rdInterRequestInterval = nullptr
rdObject *	rdInterSessionInterval = nullptr
rdObject *	rdRequestSize = nullptr
rdObject *	rdReqInSession = nullptr
long	htmlRequested = 0
long	htmlReceived = 0
long	htmlErrorsReceived = 0
long	imgResourcesRequested = 0
long	imgResourcesReceived = 0
long	textResourcesRequested = 0
long	textResourcesReceived = 0
long	messagesInCurrentSession = 0
long	sessionCount = 0
long	connectionsCount = 0
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
Protected Types inherited from inet::httptools::HttpBrowserBase
typedef std::deque< BrowseEvent >	BrowseEventsList
typedef std::deque< HttpRequestMessage * >	HttpRequestQueue

Detailed Description

Browser module.

The component is designed to plug into the existing INET StandardHost module as a tcpApp. See the INET documentation and examples for details.

This component uses the TCP/IP modeling of the INET framework for transport. Specifically, the TCPSocket class is used to interface with the TCP component from the INET framework. A light-weight module which uses direct message passing is also available (HttpBrowserDirect).

Author

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

See also

HttpBrowserBase

HttpBrowserDirect

Constructor & Destructor Documentation

inet::httptools::HttpBrowser::HttpBrowser

(

)

{
}

inet::httptools::HttpBrowser::~HttpBrowser ( )

virtual

{
    // @todo Delete socket data structures
    sockCollection.deleteSockets();
}

Member Function Documentation

void inet::httptools::HttpBrowser::finish ( )

overrideprotectedvirtual

Reimplemented from inet::httptools::HttpBrowserBase.

{
    // Call the parent class finish. Takes care of most of the reporting.
    HttpBrowserBase::finish();

    // Report sockets related statistics.
    EV_INFO << "Sockets opened: " << socketsOpened << endl;
    EV_INFO << "Broken connections: " << numBroken << endl;
    // Record the sockets related statistics
    recordScalar("sock.opened", socketsOpened);
    recordScalar("sock.broken", numBroken);
}

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

overrideprotectedvirtual

Implements inet::httptools::HttpBrowserBase.

{
    if (msg->isSelfMessage()) {
        handleSelfMessages(msg);
    }
    else {
        EV_DEBUG << "Message received: " << msg->getName() << endl;

        TCPCommand *ind = dynamic_cast<TCPCommand *>(msg->getControlInfo());
        if (!ind) {
            EV_DEBUG << "No control info for the message" << endl;
        }
        else {
            int connId = ind->getConnId();
            EV_DEBUG << "Connection ID: " << connId << endl;
        }

        // Locate the socket for the incoming message. One should definitely exist.
        TCPSocket *socket = sockCollection.findSocketFor(msg);
        if (socket == nullptr) {
            // Handle errors. @todo error instead of warning?
            EV_WARN << "No socket found for message " << msg->getName() << endl;
            delete msg;
            return;
        }
        // Submit to the socket handler. Calls the TCPSocket::CallbackInterface methods.
        // Message is deleted in the socket handler
        socket->processMessage(msg);
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::httptools::HttpBrowserBase.

{
    EV_DEBUG << "Initializing HTTP browser component (sockets version), stage " << stage << endl;
    HttpBrowserBase::initialize(stage);
}

int inet::httptools::HttpBrowser::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented from inet::httptools::HttpBrowserBase.

{ return NUM_INIT_STAGES; }

void inet::httptools::HttpBrowser::sendRequestsToServer ( std::string  www, HttpRequestQueue  queue  )

overrideprotectedvirtual

Implements inet::httptools::HttpBrowserBase.

{
    int connectPort;
    char szModuleName[127];

    if (controller->getServerInfo(www.c_str(), szModuleName, connectPort) != 0) {
        EV_ERROR << "Unable to get server info for URL " << www << endl;
        while (!queue.empty()) {
            HttpRequestMessage *msg = queue.back();
            queue.pop_back();
            delete msg;
        }
        return;
    }

    EV_DEBUG << "Sending requests to server " << www << " (" << szModuleName << ") on port " << connectPort
             << ". Total messages queued are " << queue.size() << endl;
    submitToSocket(szModuleName, connectPort, queue);
}

void inet::httptools::HttpBrowser::sendRequestToRandomServer ( )

overrideprotectedvirtual

Implements inet::httptools::HttpBrowserBase.

{
    int connectPort;
    char szWWW[127];
    char szModuleName[127];

    if (controller->getAnyServerInfo(szWWW, szModuleName, connectPort) != 0) {
        EV_ERROR << "Unable to get a random server from controller" << endl;
        return;
    }

    EV_DEBUG << "Sending request to random server " << szWWW << " (" << szModuleName << ") on port " << connectPort << endl;
    submitToSocket(szModuleName, connectPort, generateRandomPageRequest(szWWW));
}

void inet::httptools::HttpBrowser::sendRequestToServer ( BrowseEvent  be )

overrideprotectedvirtual

Implements inet::httptools::HttpBrowserBase.

{
    int connectPort;
    char szModuleName[127];

    if (controller->getServerInfo(be.wwwhost.c_str(), szModuleName, connectPort) != 0) {
        EV_ERROR << "Unable to get server info for URL " << be.wwwhost << endl;
        return;
    }

    EV_DEBUG << "Sending request to server " << be.wwwhost << " (" << szModuleName << ") on port " << connectPort << endl;
    submitToSocket(szModuleName, connectPort, generatePageRequest(be.wwwhost, be.resourceName));
}

void inet::httptools::HttpBrowser::sendRequestToServer ( HttpRequestMessage *  request )

overrideprotectedvirtual

Implements inet::httptools::HttpBrowserBase.

{
    int connectPort;
    char szModuleName[127];

    if (controller->getServerInfo(request->targetUrl(), szModuleName, connectPort) != 0) {
        EV_ERROR << "Unable to get server info for URL " << request->targetUrl() << endl;
        delete request;
        return;
    }

    EV_DEBUG << "Sending request to server " << request->targetUrl() << " (" << szModuleName << ") on port " << connectPort << endl;
    submitToSocket(szModuleName, connectPort, request);
}

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    EV_INFO << "Socket " << connId << " closed" << endl;

    if (yourPtr == nullptr) {
        EV_ERROR << "socketClosed failure. Null pointer" << endl;
        return;
    }

    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;
    sockCollection.removeSocket(socket);
    delete socket;
}

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

overrideprotectedvirtual

Implements inet::TCPSocket::CallbackInterface.

{
    EV_DEBUG << "Socket data arrived on connection " << connId << ": " << msg->getName() << endl;
    if (yourPtr == nullptr) {
        EV_ERROR << "socketDataArrivedfailure. Null pointer" << endl;
        return;
    }

    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;
    handleDataMessage(msg);

    if (--sockdata->pending == 0) {
        EV_DEBUG << "Received last expected reply on this socket. Issuing a close" << endl;
        socket->close();
    }
    // Message deleted in handler - do not delete here!
}

void inet::httptools::HttpBrowser::socketDeleted ( int  connId, void *  yourPtr  )

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    if (yourPtr == nullptr) {
        throw cRuntimeError("Model error: socketDelete failure. yourPtr is null pointer");
    }

    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;
    ASSERT(connId == socket->getConnectionId());
    HttpRequestQueue& queue = sockdata->messageQueue;
    while (!queue.empty()) {
        HttpRequestMessage *msg = queue.back();
        queue.pop_back();
        delete msg;
    }
    delete sockdata;
}

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    EV_DEBUG << "Socket with id " << connId << " established" << endl;

    socketsOpened++;

    if (yourPtr == nullptr) {
        EV_ERROR << "SocketEstablished failure. Null pointer" << endl;
        return;
    }

    // Get the socket and associated data structure.
    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;
    if (sockdata->messageQueue.empty()) {
        EV_INFO << "No data to send on socket with connection id " << connId << ". Closing" << endl;
        socket->close();
        return;
    }

    // Send pending messages on the established socket.
    EV_DEBUG << "Proceeding to send messages on socket " << connId << endl;
    while (!sockdata->messageQueue.empty()) {
        cMessage *msg = sockdata->messageQueue.back();
        cPacket *pckt = check_and_cast<cPacket *>(msg);
        sockdata->messageQueue.pop_back();
        EV_DEBUG << "Submitting request " << msg->getName() << " to socket " << connId << ". size is " << pckt->getByteLength() << " bytes" << endl;
        socket->send(msg);
        sockdata->pending++;
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    EV_WARN << "connection broken. Connection id " << connId << endl;
    numBroken++;

    if (yourPtr == nullptr) {
        EV_ERROR << "socketFailure failure. Null pointer" << endl;
        return;
    }

    if (code == TCP_I_CONNECTION_RESET)
        EV_WARN << "Connection reset!\n";
    else if (code == TCP_I_CONNECTION_REFUSED)
        EV_WARN << "Connection refused!\n";

    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;
    sockCollection.removeSocket(socket);
    delete socket;
}

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    EV_DEBUG << "Socket " << connId << " closed by peer" << endl;
    if (yourPtr == nullptr) {
        EV_ERROR << "socketPeerClosed failure. Null pointer" << endl;
        return;
    }

    SockData *sockdata = (SockData *)yourPtr;
    TCPSocket *socket = sockdata->socket;

    // 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();
    }
}

void inet::httptools::HttpBrowser::socketStatusArrived ( int  connId, void *  yourPtr, TCPStatusInfo *  status  )

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

{
    // This is obviously not used at the present time.
    EV_INFO << "SOCKET STATUS ARRIVED. Socket: " << connId << endl;
}

void inet::httptools::HttpBrowser::submitToSocket ( const char *  moduleName, int  connectPort, HttpRequestMessage *  msg  )

protected

Referenced by sendRequestsToServer(), sendRequestToRandomServer(), and sendRequestToServer().

{
    // Create a queue and push the single message
    HttpRequestQueue queue;
    queue.push_back(msg);
    // Call the overloaded version with the queue as parameter
    submitToSocket(moduleName, connectPort, queue);
}

void inet::httptools::HttpBrowser::submitToSocket ( const char *  moduleName, int  connectPort, HttpRequestQueue &  queue  )

protected

Establishes a socket and assigns a queue of messages to be transmitted.

Same as the overloaded version, except a number of messages are queued for transmission. The same socket instance is used for all the queued messages.

{
    // Don't do anything if the queue is empty.
    if (queue.empty()) {
        EV_INFO << "Submitting to socket. No data to send to " << moduleName << ". Skipping connection." << endl;
        return;
    }

    EV_DEBUG << "Submitting to socket. Module: " << moduleName << ", port: " << connectPort << ". Total messages: " << queue.size() << endl;

    // Create and initialize the socket
    TCPSocket *socket = new TCPSocket();
    socket->setDataTransferMode(TCP_TRANSFER_OBJECT);
    socket->setOutputGate(gate("tcpOut"));
    sockCollection.addSocket(socket);

    // Initialize the associated data structure
    SockData *sockdata = new SockData;
    sockdata->messageQueue = HttpRequestQueue(queue);
    sockdata->socket = socket;
    sockdata->pending = 0;
    socket->setCallbackObject(this, sockdata);

    // Issue a connect to the socket for the specified module and port.
    socket->connect(L3AddressResolver().resolve(moduleName), connectPort);
}

Member Data Documentation

unsigned long inet::httptools::HttpBrowser::numBroken = 0

protected

Referenced by finish(), and socketFailure().

TCPSocketMap inet::httptools::HttpBrowser::sockCollection

protected

Referenced by handleMessage(), socketClosed(), socketFailure(), submitToSocket(), and ~HttpBrowser().

unsigned long inet::httptools::HttpBrowser::socketsOpened = 0

protected

Referenced by finish(), and socketEstablished().

---

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

• HttpBrowser.h
• HttpBrowser.cc