23#include <ns3/callback.h>
24#include <ns3/config.h>
25#include <ns3/inet-socket-address.h>
26#include <ns3/inet6-socket-address.h>
28#include <ns3/packet.h>
29#include <ns3/pointer.h>
30#include <ns3/simulator.h>
31#include <ns3/socket.h>
32#include <ns3/tcp-socket-factory.h>
33#include <ns3/tcp-socket.h>
34#include <ns3/three-gpp-http-variables.h>
35#include <ns3/uinteger.h>
47 : m_state(NOT_STARTED),
48 m_initialSocket(nullptr),
63 TypeId(
"ns3::ThreeGppHttpServer")
65 .AddConstructor<ThreeGppHttpServer>()
66 .AddAttribute(
"Variables",
67 "Variable collection, which is used to control e.g. processing and "
68 "object generation delays.",
71 MakePointerChecker<ThreeGppHttpVariables>())
72 .AddAttribute(
"LocalAddress",
73 "The local address of the server, "
74 "i.e., the address on which to bind the Rx socket.",
78 .AddAttribute(
"LocalPort",
79 "Port on which the application listen for incoming packets.",
82 MakeUintegerChecker<uint16_t>())
84 "Maximum transmission unit (in bytes) of the TCP sockets "
85 "used in this application, excluding the compulsory 40 "
86 "bytes TCP header. Typical values are 1460 and 536 bytes. "
87 "The attribute is read-only because the value is randomly "
92 MakeUintegerChecker<uint32_t>())
94 "ConnectionEstablished",
95 "Connection to a remote web client has been established.",
97 "ns3::HttpServer::ConnectionEstablishedCallback")
98 .AddTraceSource(
"MainObject",
99 "A main object has been generated.",
101 "ns3::HttpServer::HttpObjectCallback")
102 .AddTraceSource(
"EmbeddedObject",
103 "An embedded object has been generated.",
105 "ns3::HttpServer::HttpObjectCallback")
106 .AddTraceSource(
"Tx",
107 "A packet has been sent.",
109 "ns3::Packet::TracedCallback")
110 .AddTraceSource(
"Rx",
111 "A packet has been received.",
113 "ns3::Packet::PacketAddressTracedCallback")
114 .AddTraceSource(
"RxDelay",
115 "A packet has been received with delay information.",
117 "ns3::Application::DelayAddressCallback")
118 .AddTraceSource(
"StateTransition",
119 "Trace fired upon every HTTP client state transition.",
121 "ns3::Application::StateTransitionCallback");
157 return "NOT_STARTED";
167 return "FATAL_ERROR";
201 if (attrInfo.
name ==
"SegmentSize")
216 << inetSocket <<
".");
226 << inet6Socket <<
".");
324 <<
" when the server instance is still running.");
327 else if (
m_txBuffer->IsSocketAvailable(socket))
360 <<
" when the server instance is still running.");
363 else if (
m_txBuffer->IsSocketAvailable(socket))
377 while ((packet = socket->
RecvFrom(from)))
410 Time processingDelay;
415 NS_LOG_INFO(
this <<
" Will finish generating a main object"
416 <<
" in " << processingDelay.
As(
Time::S) <<
".");
427 NS_LOG_INFO(
this <<
" Will finish generating an embedded object"
428 <<
" in " << processingDelay.
As(
Time::S) <<
".");
459 if (actualSent < txBufferSize)
461 switch (
m_txBuffer->GetBufferContentType(socket))
464 NS_LOG_INFO(
this <<
" Transmission of main object is suspended"
465 <<
" after " << actualSent <<
" bytes.");
468 NS_LOG_INFO(
this <<
" Transmission of embedded object is suspended"
469 <<
" after " << actualSent <<
" bytes.");
478 switch (
m_txBuffer->GetBufferContentType(socket))
481 NS_LOG_INFO(
this <<
" Finished sending a whole main object.");
484 NS_LOG_INFO(
this <<
" Finished sending a whole embedded object.");
503 NS_LOG_INFO(
this <<
" Main object to be served is " << objectSize <<
" bytes.");
508 if (actualSent < objectSize)
510 NS_LOG_INFO(
this <<
" Transmission of main object is suspended"
511 <<
" after " << actualSent <<
" bytes.");
515 NS_LOG_INFO(
this <<
" Finished sending a whole main object.");
525 NS_LOG_INFO(
this <<
" Embedded object to be served is " << objectSize <<
" bytes.");
530 if (actualSent < objectSize)
532 NS_LOG_INFO(
this <<
" Transmission of embedded object is suspended"
533 <<
" after " << actualSent <<
" bytes.");
537 NS_LOG_INFO(
this <<
" Finished sending a whole embedded object.");
548 NS_LOG_LOGIC(
this <<
" Tx buffer is empty. Not sending anything.");
551 bool firstPartOfObject = !
m_txBuffer->HasTxedPartOfObject(socket);
554 NS_LOG_DEBUG(
this <<
" Socket has " << socketSize <<
" bytes available for Tx.");
566 NS_LOG_LOGIC(
this <<
" Socket size leads to packet size of zero; not sending anything.");
571 if (firstPartOfObject)
584 <<
" The corresponding request came "
590 <<
" bytes to be appended to a previous packet.");
594 const int actualBytes = socket->
Send(packet);
596 <<
" return value= " << actualBytes <<
".");
599 if (actualBytes ==
static_cast<int>(
packetSize))
602 m_txBuffer->DepleteBufferSize(socket, contentSize);
610 <<
" GetErrNo= " << socket->
GetErrno() <<
","
611 <<
" suspending transmission"
612 <<
" and waiting for another Tx opportunity.");
625 NS_LOG_INFO(
this <<
" ThreeGppHttpServer " << oldState <<
" --> " << newState <<
".");
639 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
650 this <<
" Cannot add socket " << socket
651 <<
" because it has already been added before.");
666 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
672 NS_LOG_INFO(
this <<
" Canceling a serving event which is due in "
690 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
696 NS_LOG_INFO(
this <<
" Canceling a serving event which is due in "
701 if (it->second.txBufferSize > 0)
703 NS_LOG_WARN(
this <<
" Closing a socket where " << it->second.txBufferSize
704 <<
" bytes of transmission"
705 <<
" is still pending in the corresponding Tx buffer.");
722 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
727 NS_LOG_INFO(
this <<
" Canceling a serving event which is due in "
745 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
748 return (it->second.txBufferSize == 0);
754 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
757 return it->second.clientTs;
763 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
766 return it->second.txBufferContentType;
772 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
775 return it->second.txBufferSize;
781 std::map<Ptr<Socket>,
TxBuffer_t>::const_iterator it;
784 return it->second.hasTxedPartOfObject;
795 "Unable to write an object without a proper Content-Type.");
796 NS_ASSERT_MSG(objectSize > 0,
"Unable to write a zero-sized object.");
798 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
802 "Cannot write to Tx buffer of socket "
803 << socket <<
" until the previous content has been completely sent.");
804 it->second.txBufferContentType = contentType;
805 it->second.txBufferSize = objectSize;
806 it->second.hasTxedPartOfObject =
false;
812 const Time& clientTs)
816 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
819 it->second.nextServe = eventId;
820 it->second.clientTs = clientTs;
830 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
834 "The requested amount is larger than the current buffer size.");
835 it->second.txBufferSize -= amount;
836 it->second.hasTxedPartOfObject =
true;
838 if (it->second.isClosing && (it->second.txBufferSize == 0))
853 std::map<Ptr<Socket>,
TxBuffer_t>::iterator it;
856 it->second.isClosing =
true;
a polymophic address class
AttributeValue implementation for Address.
The base class for all ns3 applications.
void DoDispose() override
Destructor implementation.
Ptr< Node > GetNode() const
An identifier for simulation events.
static Inet6SocketAddress ConvertFrom(const Address &addr)
Convert the address to a InetSocketAddress.
uint16_t GetPort() const
Get the port.
static bool IsMatchingType(const Address &addr)
If the address match.
Ipv6Address GetIpv6() const
Get the IPv6 address.
static bool IsMatchingType(const Address &address)
Ipv4Address GetIpv4() const
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
Ipv4 addresses are stored in host order in this class.
static Ipv4Address ConvertFrom(const Address &address)
static bool IsMatchingType(const Address &address)
Describes an IPv6 address.
static Ipv6Address ConvertFrom(const Address &address)
Convert the Address object into an Ipv6Address ones.
static bool IsMatchingType(const Address &address)
If the Address matches the type.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
void AddHeader(const Header &header)
Add header to this packet.
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
uint32_t PeekHeader(Header &header) const
Deserialize but does not remove the header from the internal buffer.
Hold objects of type Ptr<T>.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static void Cancel(const EventId &id)
Set the cancel bit on this event: the event's associated function will not be invoked when it expires...
static bool IsFinished()
Check if the simulation should finish.
static Time Now()
Return the current simulation virtual time.
static bool IsExpired(const EventId &id)
Check if an event has already run or been cancelled.
static Time GetDelayLeft(const EventId &id)
Get the remaining time until this event will execute.
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual Ptr< Packet > RecvFrom(uint32_t maxSize, uint32_t flags, Address &fromAddress)=0
Read a single packet from the socket and retrieve the sender address.
void SetAcceptCallback(Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
Accept connection requests from remote hosts.
virtual int ShutdownSend()=0
void SetSendCallback(Callback< void, Ptr< Socket >, uint32_t > sendCb)
Notify application when space in transmit buffer is added.
void SetCloseCallbacks(Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
Detect socket recv() events such as graceful shutdown or error.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
virtual enum Socket::SocketErrno GetErrno() const =0
Get last error number.
virtual int Close()=0
Close a socket.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
virtual int Listen()=0
Listen for incoming connections.
virtual uint32_t GetTxAvailable() const =0
Returns the number of bytes which can be sent in a single call to Send.
static TypeId GetTypeId()
Get the type ID.
static TypeId GetTypeId()
Get the type ID.
State_t
The possible states of the application.
@ NOT_STARTED
Before StartApplication() is invoked.
@ STOPPED
After StopApplication() is invoked.
@ STARTED
Passively listening and responding to requests.
void StartApplication() override
Application specific startup code.
uint32_t ServeFromTxBuffer(Ptr< Socket > socket)
Creates a packet out of a pending object in the Tx buffer send it over the given socket.
State_t m_state
The current state of the client application. Begins with NOT_STARTED.
Ptr< ThreeGppHttpVariables > m_httpVariables
The Variables attribute.
uint16_t m_localPort
The LocalPort attribute.
TracedCallback< uint32_t > m_embeddedObjectTrace
The EmbeddedObject trace source.
Address m_localAddress
The LocalAddress attribute.
void ReceivedDataCallback(Ptr< Socket > socket)
Invoked when m_initialSocket receives some packet data.
void ServeNewMainObject(Ptr< Socket > socket)
Generates a new main object and push it into the Tx buffer.
TracedCallback< uint32_t > m_mainObjectTrace
The MainObject trace source.
uint32_t m_mtuSize
The Mtu attribute.
TracedCallback< const Time &, const Address & > m_rxDelayTrace
The RxDelay trace source.
State_t GetState() const
Returns the current state of the application.
Ptr< ThreeGppHttpServerTxBuffer > m_txBuffer
Pointer to the transmission buffer.
bool ConnectionRequestCallback(Ptr< Socket > socket, const Address &address)
Invoked when m_initialSocket receives a connection request.
void ServeNewEmbeddedObject(Ptr< Socket > socket)
Generates a new embedded object and push it into the Tx buffer.
TracedCallback< const std::string &, const std::string & > m_stateTransitionTrace
The StateTransition trace source.
void ErrorCloseCallback(Ptr< Socket > socket)
Invoked when a connection with a web client is terminated.
void SendCallback(Ptr< Socket > socket, uint32_t availableBufferSize)
Invoked when more buffer space for transmission is added to a socket.
TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
The Rx trace source.
Ptr< Socket > GetSocket() const
Returns a pointer to the listening socket.
TracedCallback< Ptr< const ThreeGppHttpServer >, Ptr< Socket > > m_connectionEstablishedTrace
The ConnectionEstablished trace source.
Ptr< Socket > m_initialSocket
The listening socket, for receiving connection requests from clients.
static TypeId GetTypeId()
Returns the object TypeId.
std::string GetStateString() const
Returns the current state of the application in string format.
ThreeGppHttpServer()
Creates a new instance of HTTP server application.
TracedCallback< Ptr< const Packet > > m_txTrace
The Tx trace source.
void NormalCloseCallback(Ptr< Socket > socket)
Invoked when a connection with a web client is terminated.
void DoDispose() override
Destructor implementation.
void StopApplication() override
Application specific shutdown code.
void NewConnectionCreatedCallback(Ptr< Socket > socket, const Address &address)
Invoked when a new connection has been established.
void SetMtuSize(uint32_t mtuSize)
Sets the maximum transmission unit (MTU) size used by the application.
void SwitchToState(State_t state)
Change the state of the server.
void DepleteBufferSize(Ptr< Socket > socket, uint32_t amount)
Decrements a buffer size by a given amount.
ThreeGppHttpHeader::ContentType_t GetBufferContentType(Ptr< Socket > socket) const
Returns ThreeGppHttpHeader::NOT_SET when the buffer is new and never been filled with any data before...
uint32_t GetBufferSize(Ptr< Socket > socket) const
void CloseAllSockets()
Close and remove all stored sockets, hence clearing the buffer.
bool HasTxedPartOfObject(Ptr< Socket > socket) const
void PrepareClose(Ptr< Socket > socket)
Tell the buffer to close the associated socket once the buffer becomes empty.
Time GetClientTs(Ptr< Socket > socket) const
void CloseSocket(Ptr< Socket > socket)
Close and remove a socket and its associated transmission buffer, and then unset the socket's callbac...
ThreeGppHttpServerTxBuffer()
Create an empty instance of transmission buffer.
void RecordNextServe(Ptr< Socket > socket, const EventId &eventId, const Time &clientTs)
Informs about a pending transmission event associated with the socket, so that it would be automatica...
std::map< Ptr< Socket >, TxBuffer_t > m_txBuffer
Collection of accepted sockets and its individual transmission buffer.
void WriteNewObject(Ptr< Socket > socket, ThreeGppHttpHeader::ContentType_t contentType, uint32_t objectSize)
Writes a data representing a new main object or embedded object to the transmission buffer.
bool IsBufferEmpty(Ptr< Socket > socket) const
bool IsSocketAvailable(Ptr< Socket > socket) const
This method is typically used before calling other methods.
void AddSocket(Ptr< Socket > socket)
Add a new socket and create an empty transmission buffer for it.
void RemoveSocket(Ptr< Socket > socket)
Remove a socket and its associated transmission buffer, and then unset the socket's callbacks to prev...
Container of various random variables to assist in generating web browsing traffic pattern.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
a unique identifier for an interface.
@ ATTR_GET
The attribute can be read.
struct TypeId::AttributeInformation GetAttribute(std::size_t i) const
Get Attribute information by index.
std::size_t GetAttributeN() const
Get the number of attributes.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Callback< R, Args... > MakeNullCallback()
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Set of fields representing a single transmission buffer, which will be associated with a socket.
ThreeGppHttpHeader::ContentType_t txBufferContentType
The content type of the current data inside the transmission buffer.
uint32_t txBufferSize
The length (in bytes) of the current data inside the transmission buffer.
bool isClosing
True if the remote end has issued a request to close, which means that this socket will immediately c...
bool hasTxedPartOfObject
True if the buffer content has been read since it is written.
static const uint32_t packetSize
Packet size generated at the AP.