INET Framework for OMNeT++/OMNEST
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
inet::httptools::HttpBaseMessage Class Reference

Class generated from inet/applications/httptools/common/HttpMessages.msg:72 by nedtool. More...

#include <HttpMessages_m.h>

Inheritance diagram for inet::httptools::HttpBaseMessage:
inet::httptools::HttpReplyMessage inet::httptools::HttpRequestMessage

Public Member Functions

 HttpBaseMessage (const char *name=nullptr, short kind=0)
 
 HttpBaseMessage (const HttpBaseMessage &other)
 
virtual ~HttpBaseMessage ()
 
HttpBaseMessage & operator= (const HttpBaseMessage &other)
 
virtual HttpBaseMessage * dup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual const char * targetUrl () const
 
virtual void setTargetUrl (const char *targetUrl)
 
virtual const char * originatorUrl () const
 
virtual void setOriginatorUrl (const char *originatorUrl)
 
virtual int protocol () const
 
virtual void setProtocol (int protocol)
 
virtual bool keepAlive () const
 
virtual void setKeepAlive (bool keepAlive)
 
virtual int serial () const
 
virtual void setSerial (int serial)
 
virtual const char * heading () const
 
virtual void setHeading (const char *heading)
 
virtual const char * payload () const
 
virtual void setPayload (const char *payload)
 

Protected Member Functions

bool operator== (const HttpBaseMessage &)
 

Protected Attributes

::omnetpp::opp_string targetUrl_var
 
::omnetpp::opp_string originatorUrl_var
 
int protocol_var
 
bool keepAlive_var
 
int serial_var
 
::omnetpp::opp_string heading_var
 
::omnetpp::opp_string payload_var
 

Private Member Functions

void copy (const HttpBaseMessage &other)
 

Detailed Description

Class generated from inet/applications/httptools/common/HttpMessages.msg:72 by nedtool. 

//
// Base class for HTTP messages
//
packet HttpBaseMessage
{
    @omitGetVerb(true);
    @fieldNameSuffix("_var");
    string targetUrl;               // The target URL - request set for browsers, echoed by servers.
    string originatorUrl = "";      // The originator URL. Only applicable for servers.
    int protocol = 11;              // 10 for http/1.0, 11 for http/1.1.
    bool keepAlive = true;          // The keep-alive header
    int serial = 0;                 // Convenience field which allows resource requests to be serially tagged for ease of analysis.
    string heading = "";                // The message heading - request string for requests, response for replies
    string payload = "";                // The payload field
}

Constructor & Destructor Documentation

inet::httptools::HttpBaseMessage::HttpBaseMessage ( const char *  name = nullptr,
short  kind = 0 
)
inet::httptools::HttpBaseMessage::HttpBaseMessage ( const HttpBaseMessage &  other)
virtual inet::httptools::HttpBaseMessage::~HttpBaseMessage ( )
virtual

Member Function Documentation

void inet::httptools::HttpBaseMessage::copy ( const HttpBaseMessage &  other)
private
virtual HttpBaseMessage* inet::httptools::HttpBaseMessage::dup ( ) const
inlineoverridevirtual

Reimplemented in inet::httptools::HttpReplyMessage, and inet::httptools::HttpRequestMessage.

77 {return new HttpBaseMessage(*this);}
inet::httptools::HttpBaseMessage::HttpBaseMessage
HttpBaseMessage(const char *name=nullptr, short kind=0)
virtual const char* inet::httptools::HttpBaseMessage::heading ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), inet::httptools::HttpNodeBase::formatHttpResponseShort(), inet::httptools::HttpServerBase::generateResourceMessage(), inet::httptools::HttpServerBase::handleGetRequest(), and inet::httptools::HttpServerBase::handleReceivedMessage().

virtual bool inet::httptools::HttpBaseMessage::keepAlive ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), and inet::httptools::HttpNodeBase::formatHttpResponseShort().

HttpBaseMessage& inet::httptools::HttpBaseMessage::operator= ( const HttpBaseMessage &  other)
bool inet::httptools::HttpBaseMessage::operator== ( const HttpBaseMessage &  )
protected
virtual const char* inet::httptools::HttpBaseMessage::originatorUrl ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), inet::httptools::HttpNodeBase::formatHttpResponseShort(), inet::httptools::HttpServerBase::generateDocument(), inet::httptools::HttpServerBase::generateErrorReply(), inet::httptools::HttpServerBase::generateResourceMessage(), and inet::httptools::HttpBrowserBase::handleDataMessage().

virtual void inet::httptools::HttpBaseMessage::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual

Reimplemented in inet::httptools::HttpReplyMessage, and inet::httptools::HttpRequestMessage.

Referenced by inet::httptools::doParsimPacking().

virtual void inet::httptools::HttpBaseMessage::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual

Reimplemented in inet::httptools::HttpReplyMessage, and inet::httptools::HttpRequestMessage.

Referenced by inet::httptools::doParsimUnpacking().

virtual const char* inet::httptools::HttpBaseMessage::payload ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpResponseLong(), and inet::httptools::HttpBrowserBase::handleDataMessage().

virtual int inet::httptools::HttpBaseMessage::protocol ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), inet::httptools::HttpNodeBase::formatHttpResponseShort(), inet::httptools::HttpServerBase::generateDocument(), inet::httptools::HttpServerBase::generateErrorReply(), and inet::httptools::HttpServerBase::generateResourceMessage().

virtual int inet::httptools::HttpBaseMessage::serial ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), inet::httptools::HttpNodeBase::formatHttpResponseShort(), inet::httptools::HttpServerBase::generateDocument(), inet::httptools::HttpServerBase::generateErrorReply(), inet::httptools::HttpServerBase::generateResourceMessage(), and inet::httptools::HttpBrowserBase::handleDataMessage().

virtual void inet::httptools::HttpBaseMessage::setHeading ( const char *  heading)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument(), and inet::httptools::HttpServerBase::generateErrorReply().

virtual void inet::httptools::HttpBaseMessage::setKeepAlive ( bool  keepAlive)
virtual
virtual void inet::httptools::HttpBaseMessage::setOriginatorUrl ( const char *  originatorUrl)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument(), and inet::httptools::HttpServerBase::generateErrorReply().

virtual void inet::httptools::HttpBaseMessage::setPayload ( const char *  payload)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument().

virtual void inet::httptools::HttpBaseMessage::setProtocol ( int  protocol)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument(), and inet::httptools::HttpServerBase::generateErrorReply().

virtual void inet::httptools::HttpBaseMessage::setSerial ( int  serial)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument(), and inet::httptools::HttpServerBase::generateErrorReply().

virtual void inet::httptools::HttpBaseMessage::setTargetUrl ( const char *  targetUrl)
virtual

Referenced by inet::httptools::HttpServerBase::generateDocument(), and inet::httptools::HttpServerBase::generateErrorReply().

virtual const char* inet::httptools::HttpBaseMessage::targetUrl ( ) const
virtual

Referenced by inet::httptools::HttpNodeBase::formatHttpRequestLong(), inet::httptools::HttpNodeBase::formatHttpRequestShort(), inet::httptools::HttpNodeBase::formatHttpResponseLong(), inet::httptools::HttpNodeBase::formatHttpResponseShort(), inet::httptools::HttpServerBase::handleReceivedMessage(), inet::httptools::HttpBrowserDirect::sendRequestToServer(), and inet::httptools::HttpBrowser::sendRequestToServer().

Member Data Documentation

::omnetpp::opp_string inet::httptools::HttpBaseMessage::heading_var
protected
bool inet::httptools::HttpBaseMessage::keepAlive_var
protected
::omnetpp::opp_string inet::httptools::HttpBaseMessage::originatorUrl_var
protected
::omnetpp::opp_string inet::httptools::HttpBaseMessage::payload_var
protected
int inet::httptools::HttpBaseMessage::protocol_var
protected
int inet::httptools::HttpBaseMessage::serial_var
protected
::omnetpp::opp_string inet::httptools::HttpBaseMessage::targetUrl_var
protected
The documentation for this class was generated from the following file: