A Discrete-Event Network Simulator
API
three-gpp-http-client.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2013 Magister Solutions
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Budiarto Herman <budiarto.herman@magister.fi>
18 *
19 */
20
22
23#include <ns3/callback.h>
24#include <ns3/double.h>
25#include <ns3/inet-socket-address.h>
26#include <ns3/inet6-socket-address.h>
27#include <ns3/log.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/three-gpp-http-variables.h>
34#include <ns3/uinteger.h>
35
36NS_LOG_COMPONENT_DEFINE("ThreeGppHttpClient");
37
38namespace ns3
39{
40
41NS_OBJECT_ENSURE_REGISTERED(ThreeGppHttpClient);
42
44 : m_state(NOT_STARTED),
45 m_socket(nullptr),
46 m_objectBytesToBeReceived(0),
47 m_objectClientTs(MilliSeconds(0)),
48 m_objectServerTs(MilliSeconds(0)),
49 m_embeddedObjectsToBeRequested(0),
50 m_httpVariables(CreateObject<ThreeGppHttpVariables>())
51{
52 NS_LOG_FUNCTION(this);
53}
54
55// static
58{
59 static TypeId tid =
60 TypeId("ns3::ThreeGppHttpClient")
62 .AddConstructor<ThreeGppHttpClient>()
63 .AddAttribute(
64 "Variables",
65 "Variable collection, which is used to control e.g. timing and HTTP request size.",
68 MakePointerChecker<ThreeGppHttpVariables>())
69 .AddAttribute("RemoteServerAddress",
70 "The address of the destination server.",
73 MakeAddressChecker())
74 .AddAttribute("RemoteServerPort",
75 "The destination port of the outbound packets.",
76 UintegerValue(80), // the default HTTP port
78 MakeUintegerChecker<uint16_t>())
79 .AddTraceSource(
80 "ConnectionEstablished",
81 "Connection to the destination web server has been established.",
83 "ns3::ThreeGppHttpClient::TracedCallback")
84 .AddTraceSource("ConnectionClosed",
85 "Connection to the destination web server is closed.",
87 "ns3::ThreeGppHttpClient::TracedCallback")
88 .AddTraceSource("Tx",
89 "General trace for sending a packet of any kind.",
91 "ns3::Packet::TracedCallback")
92 .AddTraceSource(
93 "TxMainObjectRequest",
94 "Sent a request for a main object.",
96 "ns3::Packet::TracedCallback")
97 .AddTraceSource(
98 "TxEmbeddedObjectRequest",
99 "Sent a request for an embedded object.",
101 "ns3::Packet::TracedCallback")
102 .AddTraceSource("RxMainObjectPacket",
103 "A packet of main object has been received.",
105 "ns3::Packet::TracedCallback")
106 .AddTraceSource("RxMainObject",
107 "Received a whole main object. Header is included.",
109 "ns3::ThreeGppHttpClient::TracedCallback")
110 .AddTraceSource(
111 "RxEmbeddedObjectPacket",
112 "A packet of embedded object has been received.",
114 "ns3::Packet::TracedCallback")
115 .AddTraceSource("RxEmbeddedObject",
116 "Received a whole embedded object. Header is included.",
118 "ns3::ThreeGppHttpClient::TracedCallback")
119 .AddTraceSource("Rx",
120 "General trace for receiving a packet of any kind.",
122 "ns3::Packet::PacketAddressTracedCallback")
123 .AddTraceSource("RxDelay",
124 "General trace of delay for receiving a complete object.",
126 "ns3::Application::DelayAddressCallback")
127 .AddTraceSource(
128 "RxRtt",
129 "General trace of round trip delay time for receiving a complete object.",
131 "ns3::Application::DelayAddressCallback")
132 .AddTraceSource("StateTransition",
133 "Trace fired upon every HTTP client state transition.",
135 "ns3::Application::StateTransitionCallback");
136 return tid;
137}
138
141{
142 return m_socket;
143}
144
147{
148 return m_state;
149}
150
151std::string
153{
154 return GetStateString(m_state);
155}
156
157// static
158std::string
160{
161 switch (state)
162 {
163 case NOT_STARTED:
164 return "NOT_STARTED";
165 break;
166 case CONNECTING:
167 return "CONNECTING";
168 break;
170 return "EXPECTING_MAIN_OBJECT";
171 break;
173 return "PARSING_MAIN_OBJECT";
174 break;
176 return "EXPECTING_EMBEDDED_OBJECT";
177 break;
178 case READING:
179 return "READING";
180 break;
181 case STOPPED:
182 return "STOPPED";
183 break;
184 default:
185 NS_FATAL_ERROR("Unknown state");
186 return "FATAL_ERROR";
187 break;
188 }
189}
190
191void
193{
194 NS_LOG_FUNCTION(this);
195
197 {
199 }
200
201 Application::DoDispose(); // Chain up.
202}
203
204void
206{
207 NS_LOG_FUNCTION(this);
208
209 if (m_state == NOT_STARTED)
210 {
211 m_httpVariables->Initialize();
213 }
214 else
215 {
216 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for StartApplication().");
217 }
218}
219
220void
222{
223 NS_LOG_FUNCTION(this);
224
227 m_socket->Close();
231}
232
233void
235{
236 NS_LOG_FUNCTION(this << socket);
237
238 if (m_state == CONNECTING)
239 {
240 NS_ASSERT_MSG(m_socket == socket, "Invalid socket.");
246 }
247 else
248 {
249 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ConnectionSucceeded().");
250 }
251}
252
253void
255{
256 NS_LOG_FUNCTION(this << socket);
257
258 if (m_state == CONNECTING)
259 {
260 NS_LOG_ERROR("Client failed to connect"
261 << " to remote address " << m_remoteServerAddress << " port "
262 << m_remoteServerPort << ".");
263 }
264 else
265 {
266 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ConnectionFailed().");
267 }
268}
269
270void
272{
273 NS_LOG_FUNCTION(this << socket);
274
276
277 if (socket->GetErrno() != Socket::ERROR_NOTERROR)
278 {
279 NS_LOG_ERROR(this << " Connection has been terminated,"
280 << " error code: " << socket->GetErrno() << ".");
281 }
282
285
287}
288
289void
291{
292 NS_LOG_FUNCTION(this << socket);
293
295 if (socket->GetErrno() != Socket::ERROR_NOTERROR)
296 {
297 NS_LOG_ERROR(this << " Connection has been terminated,"
298 << " error code: " << socket->GetErrno() << ".");
299 }
300
302}
303
304void
306{
307 NS_LOG_FUNCTION(this << socket);
308
309 Ptr<Packet> packet;
310 Address from;
311
312 while ((packet = socket->RecvFrom(from)))
313 {
314 if (packet->GetSize() == 0)
315 {
316 break; // EOF
317 }
318
319#ifdef NS3_LOG_ENABLE
320 // Some log messages.
322 {
323 NS_LOG_INFO(this << " A packet of " << packet->GetSize() << " bytes"
324 << " received from " << InetSocketAddress::ConvertFrom(from).GetIpv4()
325 << " port " << InetSocketAddress::ConvertFrom(from).GetPort() << " / "
326 << InetSocketAddress::ConvertFrom(from) << ".");
327 }
329 {
330 NS_LOG_INFO(this << " A packet of " << packet->GetSize() << " bytes"
331 << " received from " << Inet6SocketAddress::ConvertFrom(from).GetIpv6()
332 << " port " << Inet6SocketAddress::ConvertFrom(from).GetPort() << " / "
333 << Inet6SocketAddress::ConvertFrom(from) << ".");
334 }
335#endif /* NS3_LOG_ENABLE */
336
337 m_rxTrace(packet, from);
338
339 switch (m_state)
340 {
342 ReceiveMainObject(packet, from);
343 break;
345 ReceiveEmbeddedObject(packet, from);
346 break;
347 default:
348 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ReceivedData().");
349 break;
350 }
351
352 } // end of `while ((packet = socket->RecvFrom (from)))`
353
354} // end of `void ReceivedDataCallback (Ptr<Socket> socket)`
355
356void
358{
359 NS_LOG_FUNCTION(this);
360
363 {
365
367 {
368 int ret [[maybe_unused]];
369
370 ret = m_socket->Bind();
371 NS_LOG_DEBUG(this << " Bind() return value= " << ret
372 << " GetErrNo= " << m_socket->GetErrno() << ".");
373
376 NS_LOG_INFO(this << " Connecting to " << ipv4 << " port " << m_remoteServerPort << " / "
377 << inetSocket << ".");
378 ret = m_socket->Connect(inetSocket);
379 NS_LOG_DEBUG(this << " Connect() return value= " << ret
380 << " GetErrNo= " << m_socket->GetErrno() << ".");
381 }
383 {
384 int ret [[maybe_unused]];
385
386 ret = m_socket->Bind6();
387 NS_LOG_DEBUG(this << " Bind6() return value= " << ret
388 << " GetErrNo= " << m_socket->GetErrno() << ".");
389
392 NS_LOG_INFO(this << " connecting to " << ipv6 << " port " << m_remoteServerPort << " / "
393 << inet6Socket << ".");
394 ret = m_socket->Connect(inet6Socket);
395 NS_LOG_DEBUG(this << " Connect() return value= " << ret
396 << " GetErrNo= " << m_socket->GetErrno() << ".");
397 }
398
399 NS_ASSERT_MSG(m_socket, "Failed creating socket.");
400
402
409 m_socket->SetAttribute("MaxSegLifetime", DoubleValue(0.02)); // 20 ms.
410
411 } // end of `if (m_state == {NOT_STARTED, EXPECTING_EMBEDDED_OBJECT, PARSING_MAIN_OBJECT,
412 // READING})`
413 else
414 {
415 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for OpenConnection().");
416 }
417
418} // end of `void OpenConnection ()`
419
420void
422{
423 NS_LOG_FUNCTION(this);
424
425 if (m_state == CONNECTING || m_state == READING)
426 {
427 ThreeGppHttpHeader header;
428 header.SetContentLength(0); // Request does not need any content length.
430 header.SetClientTs(Simulator::Now());
431
432 const uint32_t requestSize = m_httpVariables->GetRequestSize();
433 Ptr<Packet> packet = Create<Packet>(requestSize);
434 packet->AddHeader(header);
435 const uint32_t packetSize = packet->GetSize();
437 m_txTrace(packet);
438 const int actualBytes = m_socket->Send(packet);
439 NS_LOG_DEBUG(this << " Send() packet " << packet << " of " << packet->GetSize() << " bytes,"
440 << " return value= " << actualBytes << ".");
441 if (actualBytes != static_cast<int>(packetSize))
442 {
443 NS_LOG_ERROR(this << " Failed to send request for embedded object,"
444 << " GetErrNo= " << m_socket->GetErrno() << ","
445 << " waiting for another Tx opportunity.");
446 }
447 else
448 {
450 }
451 }
452 else
453 {
454 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for RequestMainObject().");
455 }
456
457} // end of `void RequestMainObject ()`
458
459void
461{
462 NS_LOG_FUNCTION(this);
463
466 {
468 {
469 ThreeGppHttpHeader header;
470 header.SetContentLength(0); // Request does not need any content length.
472 header.SetClientTs(Simulator::Now());
473
474 const uint32_t requestSize = m_httpVariables->GetRequestSize();
475 Ptr<Packet> packet = Create<Packet>(requestSize);
476 packet->AddHeader(header);
477 const uint32_t packetSize = packet->GetSize();
479 m_txTrace(packet);
480 const int actualBytes = m_socket->Send(packet);
481 NS_LOG_DEBUG(this << " Send() packet " << packet << " of " << packet->GetSize()
482 << " bytes,"
483 << " return value= " << actualBytes << ".");
484
485 if (actualBytes != static_cast<int>(packetSize))
486 {
487 NS_LOG_ERROR(this << " Failed to send request for embedded object,"
488 << " GetErrNo= " << m_socket->GetErrno() << ","
489 << " waiting for another Tx opportunity.");
490 }
491 else
492 {
495 }
496 }
497 else
498 {
499 NS_LOG_WARN(this << " No embedded object to be requested.");
500 }
501 }
502 else
503 {
504 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for RequestEmbeddedObject().");
505 }
506
507} // end of `void RequestEmbeddedObject ()`
508
509void
511{
512 NS_LOG_FUNCTION(this << packet << from);
513
515 {
516 /*
517 * In the following call to Receive(), #m_objectBytesToBeReceived *will*
518 * be updated. #m_objectClientTs and #m_objectServerTs *may* be updated.
519 * ThreeGppHttpHeader will be removed from the packet, if it is the first
520 * packet of the object to be received; the header will be available in
521 * #m_constructedPacketHeader.
522 * #m_constructedPacket will also be updated.
523 */
524 Receive(packet);
526
528 {
529 /*
530 * There are more packets of this main object, so just stay still
531 * and wait until they arrive.
532 */
533 NS_LOG_INFO(this << " " << m_objectBytesToBeReceived << " byte(s)"
534 << " remains from this chunk of main object.");
535 }
536 else
537 {
538 /*
539 * This is the last packet of this main object. Acknowledge the
540 * reception of a whole main object
541 */
542 NS_LOG_INFO(this << " Finished receiving a main object.");
544
546 {
548 m_objectServerTs = MilliSeconds(0); // Reset back to zero.
549 }
550
552 {
554 m_objectClientTs = MilliSeconds(0); // Reset back to zero.
555 }
556
558
559 } // end of else of `if (m_objectBytesToBeReceived > 0)`
560
561 } // end of `if (m_state == EXPECTING_MAIN_OBJECT)`
562 else
563 {
564 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ReceiveMainObject().");
565 }
566
567} // end of `void ReceiveMainObject (Ptr<Packet> packet)`
568
569void
571{
572 NS_LOG_FUNCTION(this << packet << from);
573
575 {
576 /*
577 * In the following call to Receive(), #m_objectBytesToBeReceived *will*
578 * be updated. #m_objectClientTs and #m_objectServerTs *may* be updated.
579 * ThreeGppHttpHeader will be removed from the packet, if it is the first
580 * packet of the object to be received; the header will be available in
581 * #m_constructedPacket, which will also be updated.
582 */
583 Receive(packet);
585
587 {
588 /*
589 * There are more packets of this embedded object, so just stay
590 * still and wait until they arrive.
591 */
592 NS_LOG_INFO(this << " " << m_objectBytesToBeReceived << " byte(s)"
593 << " remains from this chunk of embedded object");
594 }
595 else
596 {
597 /*
598 * This is the last packet of this embedded object. Acknowledge
599 * the reception of a whole embedded object
600 */
601 NS_LOG_INFO(this << " Finished receiving an embedded object.");
603
605 {
607 m_objectServerTs = MilliSeconds(0); // Reset back to zero.
608 }
609
611 {
613 m_objectClientTs = MilliSeconds(0); // Reset back to zero.
614 }
615
617 {
619 << " more embedded object(s) to be requested.");
620 // Immediately request another using the existing connection.
623 }
624 else
625 {
626 /*
627 * There is no more embedded object, the web page has been
628 * downloaded completely. Now is the time to read it.
629 */
630 NS_LOG_INFO(this << " Finished receiving a web page.");
632 }
633
634 } // end of else of `if (m_objectBytesToBeReceived > 0)`
635
636 } // end of `if (m_state == EXPECTING_EMBEDDED_OBJECT)`
637 else
638 {
639 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ReceiveEmbeddedObject().");
640 }
641
642} // end of `void ReceiveEmbeddedObject (Ptr<Packet> packet)`
643
644void
646{
647 NS_LOG_FUNCTION(this << packet);
648
649 /* In a "real" HTTP message the message size is coded differently. The use of a header
650 * is to avoid the burden of doing a real message parser.
651 */
652 bool firstPacket = false;
653
655 {
656 // This is the first packet of the object.
657 firstPacket = true;
658
659 // Remove the header in order to calculate remaining data to be received.
660 ThreeGppHttpHeader httpHeader;
661 packet->RemoveHeader(httpHeader);
662
664 m_objectClientTs = httpHeader.GetClientTs();
665 m_objectServerTs = httpHeader.GetServerTs();
666
667 // Take a copy for constructed packet trace. Note that header is included.
668 m_constructedPacket = packet->Copy();
669 m_constructedPacket->AddHeader(httpHeader);
670 }
671 uint32_t contentSize = packet->GetSize();
672
673 /* Note that the packet does not contain header at this point.
674 * The content is purely raw data, which was the only intended data to be received.
675 */
676 if (m_objectBytesToBeReceived < contentSize)
677 {
678 NS_LOG_WARN(this << " The received packet"
679 << " (" << contentSize << " bytes of content)"
680 << " is larger than"
681 << " the content that we expected to receive"
682 << " (" << m_objectBytesToBeReceived << " bytes).");
683 // Stop expecting any more packet of this object.
685 m_constructedPacket = nullptr;
686 }
687 else
688 {
689 m_objectBytesToBeReceived -= contentSize;
690 if (!firstPacket)
691 {
692 Ptr<Packet> packetCopy = packet->Copy();
693 m_constructedPacket->AddAtEnd(packetCopy);
694 }
695 }
696
697} // end of `void Receive (packet)`
698
699void
701{
702 NS_LOG_FUNCTION(this);
703
705 {
706 const Time parsingTime = m_httpVariables->GetParsingTime();
707 NS_LOG_INFO(this << " The parsing of this main object"
708 << " will complete in " << parsingTime.As(Time::S) << ".");
712 }
713 else
714 {
715 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for EnterParsingTime().");
716 }
717}
718
719void
721{
722 NS_LOG_FUNCTION(this);
723
725 {
726 m_embeddedObjectsToBeRequested = m_httpVariables->GetNumOfEmbeddedObjects();
727 NS_LOG_INFO(this << " Parsing has determined " << m_embeddedObjectsToBeRequested
728 << " embedded object(s) in the main object.");
729
731 {
732 /*
733 * Immediately request the first embedded object using the
734 * existing connection.
735 */
738 }
739 else
740 {
741 /*
742 * There is no embedded object in the main object. So sit back and
743 * enjoy the plain web page.
744 */
745 NS_LOG_INFO(this << " Finished receiving a web page.");
747 }
748 }
749 else
750 {
751 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for ParseMainObject().");
752 }
753
754} // end of `void ParseMainObject ()`
755
756void
758{
759 NS_LOG_FUNCTION(this);
760
762 {
763 const Time readingTime = m_httpVariables->GetReadingTime();
764 NS_LOG_INFO(this << " Client will finish reading this web page in "
765 << readingTime.As(Time::S) << ".");
766
767 // Schedule a request of another main object once the reading time expires.
771 }
772 else
773 {
774 NS_FATAL_ERROR("Invalid state " << GetStateString() << " for EnterReadingTime().");
775 }
776}
777
778void
780{
781 NS_LOG_FUNCTION(this);
782
784 {
785 NS_LOG_INFO(this << " Canceling RequestMainObject() which is due in "
788 }
789
791 {
792 NS_LOG_INFO(this << " Canceling RequestEmbeddedObject() which is due in "
794 << ".");
796 }
797
799 {
800 NS_LOG_INFO(this << " Canceling ParseMainObject() which is due in "
803 }
804}
805
806void
808{
809 const std::string oldState = GetStateString();
810 const std::string newState = GetStateString(state);
811 NS_LOG_FUNCTION(this << oldState << newState);
812
813 if ((state == EXPECTING_MAIN_OBJECT) || (state == EXPECTING_EMBEDDED_OBJECT))
814 {
816 {
817 NS_FATAL_ERROR("Cannot start a new receiving session"
818 << " if the previous object"
819 << " (" << m_objectBytesToBeReceived << " bytes)"
820 << " is not completely received yet.");
821 }
822 }
823
824 m_state = state;
825 NS_LOG_INFO(this << " HttpClient " << oldState << " --> " << newState << ".");
826 m_stateTransitionTrace(oldState, newState);
827}
828
829} // namespace ns3
a polymophic address class
Definition: address.h:100
AttributeValue implementation for Address.
The base class for all ns3 applications.
Definition: application.h:61
void DoDispose() override
Destructor implementation.
Definition: application.cc:85
Ptr< Node > GetNode() const
Definition: application.cc:107
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:42
An Inet6 address class.
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.
an Inet address class
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.
Definition: ipv4-address.h:43
static Ipv4Address ConvertFrom(const Address &address)
static bool IsMatchingType(const Address &address)
Describes an IPv6 address.
Definition: ipv6-address.h:50
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.
Definition: object-base.cc:200
uint32_t RemoveHeader(Header &header)
Deserialize and remove the header from the internal buffer.
Definition: packet.cc:294
void AddAtEnd(Ptr< const Packet > packet)
Concatenate the input packet at the end of the current packet.
Definition: packet.cc:354
void AddHeader(const Header &header)
Add header to this packet.
Definition: packet.cc:268
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:863
Ptr< Packet > Copy() const
performs a COW copy of the packet.
Definition: packet.cc:131
Hold objects of type Ptr<T>.
Definition: pointer.h:37
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:568
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...
Definition: simulator.cc:276
static bool IsFinished()
Check if the simulation should finish.
Definition: simulator.cc:169
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:199
static bool IsExpired(const EventId &id)
Check if an event has already run or been cancelled.
Definition: simulator.cc:286
static EventId ScheduleNow(FUNC f, Ts &&... args)
Schedule an event to expire Now.
Definition: simulator.h:606
static Time GetDelayLeft(const EventId &id)
Get the remaining time until this event will execute.
Definition: simulator.cc:208
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
void SetConnectCallback(Callback< void, Ptr< Socket > > connectionSucceeded, Callback< void, Ptr< Socket > > connectionFailed)
Specify callbacks to allow the caller to determine if the connection succeeds of fails.
Definition: socket.cc:85
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.
virtual int Bind6()=0
Allocate a local IPv6 endpoint for this socket.
virtual int Connect(const Address &address)=0
Initiate a connection to a remote host.
void SetCloseCallbacks(Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose)
Detect socket recv() events such as graceful shutdown or error.
Definition: socket.cc:94
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
Definition: socket.cc:126
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...
Definition: socket.cc:72
virtual enum Socket::SocketErrno GetErrno() const =0
Get last error number.
virtual int Close()=0
Close a socket.
@ ERROR_NOTERROR
Definition: socket.h:85
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
static TypeId GetTypeId()
Get the type ID.
ns3::TracedCallback< const Time &, const Address & > m_rxRttTrace
The RxRtt trace source.
void ReceiveMainObject(Ptr< Packet > packet, const Address &from)
Receive a packet of main object from the destination web server.
ns3::TracedCallback< Ptr< const ThreeGppHttpClient > > m_connectionClosedTrace
The ConnectionClosed trace source.
ns3::TracedCallback< const Time &, const Address & > m_rxDelayTrace
The RxDelay trace source.
ns3::TracedCallback< Ptr< const ThreeGppHttpClient >, Ptr< const Packet > > m_rxEmbeddedObjectTrace
The TxEmbeddedObject trace source.
Ptr< ThreeGppHttpVariables > m_httpVariables
The Variables attribute.
uint32_t m_embeddedObjectsToBeRequested
Determined after parsing the main object.
EventId m_eventParseMainObject
An event of ParseMainObject(), scheduled to trigger after parsing time has elapsed.
void SwitchToState(State_t state)
Change the state of the client.
void ConnectionFailedCallback(Ptr< Socket > socket)
Invoked when m_socket cannot establish a connection with the web server.
ThreeGppHttpClient()
Creates a new instance of HTTP client application.
ns3::TracedCallback< Ptr< const Packet >, const Address & > m_rxTrace
The Rx trace source.
void EnterParsingTime()
Becomes idle for a randomly determined amount of time, and then triggers ParseMainObject().
State_t m_state
The current state of the client application. Begins with NOT_STARTED.
Ptr< Socket > m_socket
The socket for sending and receiving packets to/from the web server.
void RequestEmbeddedObject()
Send a request object for an embedded object to the destination web server.
void ParseMainObject()
Randomly determines the number of embedded objects in the main object.
ns3::TracedCallback< Ptr< const ThreeGppHttpClient >, Ptr< const Packet > > m_rxMainObjectTrace
The TxMainObject trace source.
State_t GetState() const
Returns the current state of the application.
void EnterReadingTime()
Becomes idle for a randomly determined amount of time, and then triggers RequestMainObject().
void DoDispose() override
Destructor implementation.
void StartApplication() override
Application specific startup code.
Ptr< Packet > m_constructedPacket
The packet constructed of one or more parts with ThreeGppHttpHeader.
uint32_t m_objectBytesToBeReceived
According to the content length specified by the ThreeGppHttpHeader.
void ConnectionSucceededCallback(Ptr< Socket > socket)
Invoked when a connection is established successfully on m_socket.
static TypeId GetTypeId()
Returns the object TypeId.
void ErrorCloseCallback(Ptr< Socket > socket)
Invoked when connection between m_socket and the web sever is terminated.
EventId m_eventRequestMainObject
An event of either RequestMainObject() or OpenConnection(), scheduled to trigger after a connection h...
uint16_t m_remoteServerPort
The RemoteServerPort attribute.
Address m_remoteServerAddress
The RemoteServerAddress attribute. The address of the web server.
void CancelAllPendingEvents()
Cancels m_eventRequestMainObject, m_eventRequestEmbeddedObject, and m_eventParseMainObject.
Ptr< Socket > GetSocket() const
Returns a pointer to the associated socket.
ns3::TracedCallback< Ptr< const Packet > > m_txTrace
The Tx trace source.
Time m_objectClientTs
The client time stamp of the ThreeGppHttpHeader from the last received packet.
State_t
The possible states of the application.
@ CONNECTING
Sent the server a connection request and waiting for the server to be accept it.
@ NOT_STARTED
Before StartApplication() is invoked.
@ READING
User reading a web page that has just been received.
@ EXPECTING_MAIN_OBJECT
Sent the server a request for a main object and waiting to receive the packets.
@ STOPPED
After StopApplication() is invoked.
@ PARSING_MAIN_OBJECT
Parsing a main object that has just been received.
@ EXPECTING_EMBEDDED_OBJECT
Sent the server a request for an embedded object and waiting to receive the packets.
ns3::TracedCallback< Ptr< const Packet > > m_txMainObjectRequestTrace
The TxMainObjectRequest trace source.
void StopApplication() override
Application specific shutdown code.
ns3::TracedCallback< Ptr< const Packet > > m_rxMainObjectPacketTrace
The TxMainObjectPacket trace source.
ns3::TracedCallback< const std::string &, const std::string & > m_stateTransitionTrace
The StateTransition trace source.
void RequestMainObject()
Send a request object for a main object to the destination web server.
Time m_objectServerTs
The server time stamp of the ThreeGppHttpHeader from the last received packet.
void NormalCloseCallback(Ptr< Socket > socket)
Invoked when connection between m_socket and the web sever is terminated.
ns3::TracedCallback< Ptr< const ThreeGppHttpClient > > m_connectionEstablishedTrace
The ConnectionEstablished trace source.
ns3::TracedCallback< Ptr< const Packet > > m_txEmbeddedObjectRequestTrace
The TxEmbeddedObjectRequest trace source.
void ReceivedDataCallback(Ptr< Socket > socket)
Invoked when m_socket receives some packet data.
ns3::TracedCallback< Ptr< const Packet > > m_rxEmbeddedObjectPacketTrace
The TxEmbeddedObjectPacket trace source.
void Receive(Ptr< Packet > packet)
Simulate a consumption of the received packet by subtracting the packet size from the internal counte...
void ReceiveEmbeddedObject(Ptr< Packet > packet, const Address &from)
Receive a packet of embedded object from the destination web server.
void OpenConnection()
Initialize m_socket to connect to the destination web server at m_remoteServerAddress and m_remoteSer...
std::string GetStateString() const
Returns the current state of the application in string format.
EventId m_eventRequestEmbeddedObject
An event of either RequestEmbeddedObject() or OpenConnection().
Header used by web browsing applications to transmit information about content type,...
void SetClientTs(Time clientTs)
void SetContentLength(uint32_t contentLength)
void SetContentType(ContentType_t contentType)
@ EMBEDDED_OBJECT
Integer equivalent = 2.
@ MAIN_OBJECT
Integer equivalent = 1.
Container of various random variables to assist in generating web browsing traffic pattern.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition: time.cc:417
@ S
second
Definition: nstime.h:116
bool IsZero() const
Exactly equivalent to t == 0.
Definition: nstime.h:314
a unique identifier for an interface.
Definition: type-id.h:60
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:935
Hold an unsigned integer type.
Definition: uinteger.h:45
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition: assert.h:66
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Definition: pointer.h:231
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:46
Callback< R, Args... > MakeNullCallback()
Definition: callback.h:734
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition: fatal-error.h:160
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:254
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:268
#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.
Definition: log.h:261
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:275
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
Definition: object.h:579
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1348
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...
Definition: callback.h:691
static const uint32_t packetSize
Packet size generated at the AP.