A Discrete-Event Network Simulator
API
socket.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006 Georgia Tech Research Corporation
4  * 2007 INRIA
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors: George F. Riley<riley@ece.gatech.edu>
20  * Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
21  */
22 
23 #include "ns3/log.h"
24 #include "ns3/packet.h"
25 #include "node.h"
26 #include "socket.h"
27 #include "socket-factory.h"
28 #include <limits>
29 
30 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("Socket");
33 
35 
36 TypeId
38 {
39  static TypeId tid = TypeId ("ns3::Socket")
40  .SetParent<Object> ()
41  .SetGroupName("Network");
42  return tid;
43 }
44 
46  : m_manualIpTtl (false),
47  m_ipRecvTos (false),
48  m_ipRecvTtl (false),
49  m_manualIpv6Tclass (false),
50  m_manualIpv6HopLimit (false),
51  m_ipv6RecvTclass (false),
52  m_ipv6RecvHopLimit (false)
53 {
55  m_boundnetdevice = 0;
56  m_recvPktInfo = false;
57 
58  m_priority = 0;
59  m_ipTos = 0;
60  m_ipTtl = 0;
61  m_ipv6Tclass = 0;
62  m_ipv6HopLimit = 0;
63 }
64 
66 {
67  NS_LOG_FUNCTION (this);
68 }
69 
72 {
73  NS_LOG_FUNCTION (node << tid);
74  Ptr<Socket> s;
75  NS_ASSERT (node != 0);
76  Ptr<SocketFactory> socketFactory = node->GetObject<SocketFactory> (tid);
77  NS_ASSERT (socketFactory != 0);
78  s = socketFactory->CreateSocket ();
79  NS_ASSERT (s != 0);
80  return s;
81 }
82 
83 void
85  Callback<void, Ptr<Socket> > connectionSucceeded,
86  Callback<void, Ptr<Socket> > connectionFailed)
87 {
88  NS_LOG_FUNCTION (this << &connectionSucceeded << &connectionFailed);
89  m_connectionSucceeded = connectionSucceeded;
90  m_connectionFailed = connectionFailed;
91 }
92 
93 void
95  Callback<void, Ptr<Socket> > normalClose,
96  Callback<void, Ptr<Socket> > errorClose)
97 {
98  NS_LOG_FUNCTION (this << &normalClose << &errorClose);
99  m_normalClose = normalClose;
100  m_errorClose = errorClose;
101 }
102 
103 void
105  Callback<bool, Ptr<Socket>, const Address &> connectionRequest,
106  Callback<void, Ptr<Socket>, const Address&> newConnectionCreated)
107 {
108  NS_LOG_FUNCTION (this << &connectionRequest << &newConnectionCreated);
109  m_connectionRequest = connectionRequest;
110  m_newConnectionCreated = newConnectionCreated;
111 }
112 
113 void
115 {
116  NS_LOG_FUNCTION (this << &dataSent);
117  m_dataSent = dataSent;
118 }
119 
120 void
122 {
123  NS_LOG_FUNCTION (this << &sendCb);
124  m_sendCb = sendCb;
125 }
126 
127 void
129 {
130  NS_LOG_FUNCTION (this << &receivedData);
131  m_receivedData = receivedData;
132 }
133 
134 int
136 {
137  NS_LOG_FUNCTION (this << p);
138  return Send (p, 0);
139 }
140 
141 int
142 Socket::Send (const uint8_t* buf, uint32_t size, uint32_t flags)
143 {
144  NS_LOG_FUNCTION (this << &buf << size << flags);
145  Ptr<Packet> p;
146  if (buf)
147  {
148  p = Create<Packet> (buf, size);
149  }
150  else
151  {
152  p = Create<Packet> (size);
153  }
154  return Send (p, flags);
155 }
156 
157 int
158 Socket::SendTo (const uint8_t* buf, uint32_t size, uint32_t flags,
159  const Address &toAddress)
160 {
161  NS_LOG_FUNCTION (this << &buf << size << flags << &toAddress);
162  Ptr<Packet> p;
163  if(buf)
164  {
165  p = Create<Packet> (buf, size);
166  }
167  else
168  {
169  p = Create<Packet> (size);
170  }
171  return SendTo (p, flags, toAddress);
172 }
173 
176 {
177  NS_LOG_FUNCTION (this);
179 }
180 
181 int
182 Socket::Recv (uint8_t* buf, uint32_t size, uint32_t flags)
183 {
184  NS_LOG_FUNCTION (this << &buf << size << flags);
185  Ptr<Packet> p = Recv (size, flags); // read up to "size" bytes
186  if (p == 0)
187  {
188  return 0;
189  }
190  p->CopyData (buf, p->GetSize ());
191  return p->GetSize ();
192 }
193 
195 Socket::RecvFrom (Address &fromAddress)
196 {
197  NS_LOG_FUNCTION (this << &fromAddress);
198  return RecvFrom (std::numeric_limits<uint32_t>::max (), 0, fromAddress);
199 }
200 
201 int
202 Socket::RecvFrom (uint8_t* buf, uint32_t size, uint32_t flags,
203  Address &fromAddress)
204 {
205  NS_LOG_FUNCTION (this << &buf << size << flags << &fromAddress);
206  Ptr<Packet> p = RecvFrom (size, flags, fromAddress);
207  if (p == 0)
208  {
209  return 0;
210  }
211  p->CopyData (buf, p->GetSize ());
212  return p->GetSize ();
213 }
214 
215 
216 void
218 {
219  NS_LOG_FUNCTION (this);
220  if (!m_connectionSucceeded.IsNull ())
221  {
222  m_connectionSucceeded (this);
223  }
224 }
225 
226 void
228 {
229  NS_LOG_FUNCTION (this);
230  if (!m_connectionFailed.IsNull ())
231  {
232  m_connectionFailed (this);
233  }
234 }
235 
236 void
238 {
239  NS_LOG_FUNCTION (this);
240  if (!m_normalClose.IsNull ())
241  {
242  m_normalClose (this);
243  }
244 }
245 
246 void
248 {
249  NS_LOG_FUNCTION (this);
250  if (!m_errorClose.IsNull ())
251  {
252  m_errorClose (this);
253  }
254 }
255 
256 bool
258 {
259  NS_LOG_FUNCTION (this << &from);
260  if (!m_connectionRequest.IsNull ())
261  {
262  return m_connectionRequest (this, from);
263  }
264  else
265  {
266  // accept all incoming connections by default.
267  // this way people writing code don't have to do anything
268  // special like register a callback that returns true
269  // just to get incoming connections
270  return true;
271  }
272 }
273 
274 void
276 {
277  NS_LOG_FUNCTION (this << socket << from);
278  if (!m_newConnectionCreated.IsNull ())
279  {
280  m_newConnectionCreated (socket, from);
281  }
282 }
283 
284 void
285 Socket::NotifyDataSent (uint32_t size)
286 {
287  NS_LOG_FUNCTION (this << size);
288  if (!m_dataSent.IsNull ())
289  {
290  m_dataSent (this, size);
291  }
292 }
293 
294 void
295 Socket::NotifySend (uint32_t spaceAvailable)
296 {
297  NS_LOG_FUNCTION (this << spaceAvailable);
298  if (!m_sendCb.IsNull ())
299  {
300  m_sendCb (this, spaceAvailable);
301  }
302 }
303 
304 void
306 {
307  NS_LOG_FUNCTION (this);
308  if (!m_receivedData.IsNull ())
309  {
310  m_receivedData (this);
311  }
312 }
313 
314 void
316 {
317  NS_LOG_FUNCTION (this);
318  m_connectionSucceeded = MakeNullCallback<void,Ptr<Socket> > ();
319  m_connectionFailed = MakeNullCallback<void,Ptr<Socket> > ();
320  m_normalClose = MakeNullCallback<void,Ptr<Socket> > ();
321  m_errorClose = MakeNullCallback<void,Ptr<Socket> > ();
322  m_connectionRequest = MakeNullCallback<bool,Ptr<Socket>, const Address &> ();
323  m_newConnectionCreated = MakeNullCallback<void,Ptr<Socket>, const Address &> ();
324  m_dataSent = MakeNullCallback<void,Ptr<Socket>, uint32_t> ();
325  m_sendCb = MakeNullCallback<void,Ptr<Socket>, uint32_t> ();
326  m_receivedData = MakeNullCallback<void,Ptr<Socket> > ();
327 }
328 
329 void
331 {
332  NS_LOG_FUNCTION (this << netdevice);
333  if (netdevice != 0)
334  {
335  bool found = false;
336  for (uint32_t i = 0; i < GetNode ()->GetNDevices (); i++)
337  {
338  if (GetNode ()->GetDevice (i) == netdevice)
339  {
340  found = true;
341  break;
342  }
343  }
344  NS_ASSERT_MSG (found, "Socket cannot be bound to a NetDevice not existing on the Node");
345  }
346  m_boundnetdevice = netdevice;
347  return;
348 }
349 
352 {
353  NS_LOG_FUNCTION (this);
354  return m_boundnetdevice;
355 }
356 
357 void
359 {
360  NS_LOG_FUNCTION (this << flag);
361  m_recvPktInfo = flag;
362 }
363 
365 {
366  NS_LOG_FUNCTION (this);
367  return m_recvPktInfo;
368 }
369 
370 bool
372 {
373  return m_manualIpv6Tclass;
374 }
375 
376 bool
378 {
379  return m_manualIpTtl;
380 }
381 
382 bool
384 {
385  return m_manualIpv6HopLimit;
386 }
387 
388 void
389 Socket::SetPriority (uint8_t priority)
390 {
391  if (priority <= 6)
392  {
393  m_priority = priority;
394  }
395  else
396  {
397  NS_LOG_ERROR ("Cannot set a priority higher than 6");
398  }
399 }
400 
401 uint8_t
403 {
404  return m_priority;
405 }
406 
407 uint8_t
408 Socket::IpTos2Priority (uint8_t ipTos)
409 {
410  uint8_t prio = NS3_PRIO_BESTEFFORT;
411  ipTos &= 0x1e;
412  switch (ipTos >> 1)
413  {
414  case 0:
415  case 1:
416  case 2:
417  case 3:
418  prio = NS3_PRIO_BESTEFFORT;
419  break;
420  case 4:
421  case 5:
422  case 6:
423  case 7:
424  prio = NS3_PRIO_BULK;
425  break;
426  case 8:
427  case 9:
428  case 10:
429  case 11:
430  prio = NS3_PRIO_INTERACTIVE;
431  break;
432  case 12:
433  case 13:
434  case 14:
435  case 15:
437  break;
438  }
439  return prio;
440 }
441 
442 void
443 Socket::SetIpTos (uint8_t tos)
444 {
446  GetSockName (address);
447  if (GetSocketType () == NS3_SOCK_STREAM)
448  {
449  // preserve the least two significant bits of the current TOS
450  // value, which are used for ECN
451  tos &= 0xfc;
452  tos |= m_ipTos & 0x3;
453  }
454  m_ipTos = tos;
455  m_priority = IpTos2Priority (tos);
456 }
457 
458 uint8_t
459 Socket::GetIpTos (void) const
460 {
461  return m_ipTos;
462 }
463 
464 void
465 Socket::SetIpRecvTos (bool ipv4RecvTos)
466 {
467  m_ipRecvTos = ipv4RecvTos;
468 }
469 
470 bool
472 {
473  return m_ipRecvTos;
474 }
475 
476 void
478 {
480  GetSockName (address);
481 
482  //If -1 or invalid values, use default
483  if (tclass == -1 || tclass < -1 || tclass > 0xff)
484  {
485  //Print a warning
486  if (tclass < -1 || tclass > 0xff)
487  {
488  NS_LOG_WARN ("Invalid IPV6_TCLASS value. Using default.");
489  }
490  m_manualIpv6Tclass = false;
491  m_ipv6Tclass = 0;
492  }
493  else
494  {
495  m_manualIpv6Tclass = true;
496  m_ipv6Tclass = tclass;
497  }
498 }
499 
500 uint8_t
502 {
503  return m_ipv6Tclass;
504 }
505 
506 void
507 Socket::SetIpv6RecvTclass (bool ipv6RecvTclass)
508 {
509  m_ipv6RecvTclass = ipv6RecvTclass;
510 }
511 
512 bool
514 {
515  return m_ipv6RecvTclass;
516 }
517 
518 void
519 Socket::SetIpTtl (uint8_t ttl)
520 {
521  m_manualIpTtl = true;
522  m_ipTtl = ttl;
523 }
524 
525 uint8_t
526 Socket::GetIpTtl (void) const
527 {
528  return m_ipTtl;
529 }
530 
531 void
532 Socket::SetIpRecvTtl (bool ipv4RecvTtl)
533 {
534  m_ipRecvTtl = ipv4RecvTtl;
535 }
536 
537 bool
539 {
540  return m_ipRecvTtl;
541 }
542 
543 void
544 Socket::SetIpv6HopLimit (uint8_t ipHopLimit)
545 {
546  m_manualIpv6HopLimit = true;
547  m_ipv6HopLimit = ipHopLimit;
548 }
549 
550 uint8_t
552 {
553  return m_ipv6HopLimit;
554 }
555 
556 void
557 Socket::SetIpv6RecvHopLimit (bool ipv6RecvHopLimit)
558 {
559  m_ipv6RecvHopLimit = ipv6RecvHopLimit;
560 }
561 
562 bool
564 {
565  return m_ipv6RecvHopLimit;
566 }
567 
568 void
569 Socket::Ipv6JoinGroup (Ipv6Address address, Ipv6MulticastFilterMode filterMode, std::vector<Ipv6Address> sourceAddresses)
570 {
571  NS_LOG_FUNCTION (this<<address<<&filterMode<<&sourceAddresses);
572  NS_ASSERT_MSG (false,"Ipv6JoinGroup not implemented on this socket");
573 }
574 
575 void
577 {
578  NS_LOG_FUNCTION (this<<address);
579 
580  // Join Group. Note that joining a group with no sources means joining without source restrictions.
581  std::vector<Ipv6Address> sourceAddresses;
582  Ipv6JoinGroup (address, EXCLUDE, sourceAddresses);
583 }
584 
585 void
587 {
588  NS_LOG_FUNCTION (this);
590  {
591  NS_LOG_INFO (" The socket was not bound to any group.");
592  return;
593  }
594  // Leave Group. Note that joining a group with no sources means leaving it.
595  std::vector<Ipv6Address> sourceAddresses;
598 }
599 
600 /***************************************************************
601  * Socket Tags
602  ***************************************************************/
603 
605 {
606  NS_LOG_FUNCTION (this);
607 }
608 
609 void
611 {
612  NS_LOG_FUNCTION (this << static_cast<uint32_t> (ttl));
613  m_ttl = ttl;
614 }
615 
616 uint8_t
618 {
619  NS_LOG_FUNCTION (this);
620  return m_ttl;
621 }
622 
624 
625 TypeId
627 {
628  static TypeId tid = TypeId ("ns3::SocketIpTtlTag")
629  .SetParent<Tag> ()
630  .SetGroupName("Network")
631  .AddConstructor<SocketIpTtlTag> ()
632  ;
633  return tid;
634 }
635 TypeId
637 {
638  return GetTypeId ();
639 }
640 
641 uint32_t
643 {
644  NS_LOG_FUNCTION (this);
645  return 1;
646 }
647 void
649 {
650  NS_LOG_FUNCTION (this << &i);
651  i.WriteU8 (m_ttl);
652 }
653 void
655 {
656  NS_LOG_FUNCTION (this << &i);
657  m_ttl = i.ReadU8 ();
658 }
659 void
660 SocketIpTtlTag::Print (std::ostream &os) const
661 {
662  NS_LOG_FUNCTION (this << &os);
663  os << "Ttl=" << (uint32_t) m_ttl;
664 }
665 
667 {
668 }
669 
670 void
672 {
673  m_hopLimit = hopLimit;
674 }
675 
676 uint8_t
678 {
679  return m_hopLimit;
680 }
681 
683 
684 TypeId
686 {
687  static TypeId tid = TypeId ("ns3::SocketIpv6HopLimitTag")
688  .SetParent<Tag> ()
689  .SetGroupName("Network")
690  .AddConstructor<SocketIpv6HopLimitTag> ()
691  ;
692  return tid;
693 }
694 TypeId
696 {
697  return GetTypeId ();
698 }
699 
700 uint32_t
702 {
703  return 1;
704 }
705 void
707 {
708  i.WriteU8 (m_hopLimit);
709 }
710 void
712 {
713  m_hopLimit = i.ReadU8 ();
714 }
715 void
716 SocketIpv6HopLimitTag::Print (std::ostream &os) const
717 {
718  os << "HopLimit=" << (uint32_t) m_hopLimit;
719 }
720 
722 {
723  NS_LOG_FUNCTION (this);
724 }
725 void
727 {
728  NS_LOG_FUNCTION (this);
729  m_dontFragment = true;
730 }
731 void
733 {
734  NS_LOG_FUNCTION (this);
735  m_dontFragment = false;
736 }
737 bool
739 {
740  NS_LOG_FUNCTION (this);
741  return m_dontFragment;
742 }
743 
745 
746 TypeId
748 {
749  static TypeId tid = TypeId ("ns3::SocketSetDontFragmentTag")
750  .SetParent<Tag> ()
751  .SetGroupName("Network")
752  .AddConstructor<SocketSetDontFragmentTag> ();
753  return tid;
754 }
755 TypeId
757 {
758  return GetTypeId ();
759 }
760 uint32_t
762 {
763  NS_LOG_FUNCTION (this);
764  return 1;
765 }
766 void
768 {
769  NS_LOG_FUNCTION (this << &i);
770  i.WriteU8 (m_dontFragment ? 1 : 0);
771 }
772 void
774 {
775  NS_LOG_FUNCTION (this << &i);
776  m_dontFragment = (i.ReadU8 () == 1) ? true : false;
777 }
778 void
779 SocketSetDontFragmentTag::Print (std::ostream &os) const
780 {
781  NS_LOG_FUNCTION (this << &os);
782  os << (m_dontFragment ? "true" : "false");
783 }
784 
785 
787 {
788 }
789 
790 void
791 SocketIpTosTag::SetTos (uint8_t ipTos)
792 {
793  m_ipTos = ipTos;
794 }
795 
796 uint8_t
798 {
799  return m_ipTos;
800 }
801 
802 TypeId
804 {
805  static TypeId tid = TypeId ("ns3::SocketIpTosTag")
806  .SetParent<Tag> ()
807  .SetGroupName("Network")
808  .AddConstructor<SocketIpTosTag> ()
809  ;
810  return tid;
811 }
812 
813 TypeId
815 {
816  return GetTypeId ();
817 }
818 
819 uint32_t
821 {
822  return sizeof (uint8_t);
823 }
824 
825 void
827 {
828  i.WriteU8 (m_ipTos);
829 }
830 
831 void
833 {
834  m_ipTos = i.ReadU8();
835 }
836 void
837 SocketIpTosTag::Print (std::ostream &os) const
838 {
839  os << "IP_TOS = " << m_ipTos;
840 }
841 
842 
844 {
845 }
846 
847 void
849 {
850  m_priority = priority;
851 }
852 
853 uint8_t
855 {
856  return m_priority;
857 }
858 
859 TypeId
861 {
862  static TypeId tid = TypeId ("ns3::SocketPriorityTag")
863  .SetParent<Tag> ()
864  .SetGroupName("Network")
865  .AddConstructor<SocketPriorityTag> ()
866  ;
867  return tid;
868 }
869 
870 TypeId
872 {
873  return GetTypeId ();
874 }
875 
876 uint32_t
878 {
879  return sizeof (uint8_t);
880 }
881 
882 void
884 {
885  i.WriteU8 (m_priority);
886 }
887 
888 void
890 {
891  m_priority = i.ReadU8();
892 }
893 
894 void
895 SocketPriorityTag::Print (std::ostream &os) const
896 {
897  os << "SO_PRIORITY = " << m_priority;
898 }
899 
900 
902 {
903 }
904 
905 void
907 {
908  m_ipv6Tclass = tclass;
909 }
910 
911 uint8_t
913 {
914  return m_ipv6Tclass;
915 }
916 
917 TypeId
919 {
920  static TypeId tid = TypeId ("ns3::SocketIpv6TclassTag")
921  .SetParent<Tag> ()
922  .SetGroupName("Network")
923  .AddConstructor<SocketIpv6TclassTag> ()
924  ;
925  return tid;
926 }
927 
928 TypeId
930 {
931  return GetTypeId ();
932 }
933 
934 uint32_t
936 {
937  return sizeof (uint8_t);
938 }
939 
940 void
942 {
943  i.WriteU8 (m_ipv6Tclass);
944 }
945 
946 void
948 {
949  m_ipv6Tclass = i.ReadU8();
950 }
951 void
952 SocketIpv6TclassTag::Print (std::ostream &os) const
953 {
954  os << "IPV6_TCLASS = " << m_ipv6Tclass;
955 }
956 
957 } // namespace ns3
uint8_t m_ipv6HopLimit
the socket IPv6 Hop Limit
Definition: socket.h:1104
bool IsAny() const
If the IPv6 address is the "Any" address.
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:626
void SetTclass(uint8_t tclass)
Set the tag&#39;s Tclass.
Definition: socket.cc:906
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:941
bool IsManualIpTtl(void) const
Checks if the socket has a specific IPv4 TTL set.
Definition: socket.cc:377
virtual void Print(std::ostream &os) const
Definition: socket.cc:952
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
virtual void Print(std::ostream &os) const
Definition: socket.cc:660
bool IsIpv6RecvHopLimit(void) const
Ask if the socket is currently passing information about IPv6 Hop Limit up the stack.
Definition: socket.cc:563
bool m_manualIpv6HopLimit
socket has IPv6 Hop Limit set
Definition: socket.h:1099
virtual uint8_t GetIpTtl(void) const
Query the value of IP Time to Live field of this socket.
Definition: socket.cc:526
Callback template class.
Definition: callback.h:1176
void SetIpv6RecvTclass(bool ipv6RecvTclass)
Tells a socket to pass information about IPv6 Traffic Class up the stack.
Definition: socket.cc:507
uint8_t GetIpTos(void) const
Query the value of IP Type of Service of this socket.
Definition: socket.cc:459
This class implements a tag that carries the socket-specific HOPLIMIT of a packet to the IPv6 layer...
Definition: socket.h:1159
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:459
void NotifyDataRecv(void)
Notify through the callback (if set) that some data have been received.
Definition: socket.cc:305
uint8_t GetTos(void) const
Get the tag&#39;s TOS.
Definition: socket.cc:797
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:761
Ptr< Packet > Recv(void)
Read a single packet from the socket.
Definition: socket.cc:175
Socket(void)
Definition: socket.cc:45
virtual void Ipv6JoinGroup(Ipv6Address address, Ipv6MulticastFilterMode filterMode, std::vector< Ipv6Address > sourceAddresses)
Joins a IPv6 multicast group.
Definition: socket.cc:569
void NotifyConnectionFailed(void)
Notify through the callback (if set) that the connection has not been established due to an error...
Definition: socket.cc:227
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:747
Callback< bool, Ptr< Socket >, const Address & > m_connectionRequest
connection request callback
Definition: socket.h:1081
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:947
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
static Ipv6Address GetAny()
Get the "any" (::) Ipv6Address.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
virtual int GetSockName(Address &address) const =0
Get socket address.
void SetIpRecvTos(bool ipv4RecvTos)
Tells a socket to pass information about IP Type of Service up the stack.
Definition: socket.cc:465
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:831
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:918
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:814
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
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:278
virtual uint8_t GetIpv6HopLimit(void) const
Query the value of IP Hop Limit field of this socket.
Definition: socket.cc:551
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
Callback< void, Ptr< Socket > > m_connectionSucceeded
connection succeeded callback
Definition: socket.h:1077
void SetTos(uint8_t tos)
Set the tag&#39;s TOS.
Definition: socket.cc:791
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:877
bool m_recvPktInfo
if the socket should add packet info tags to the packet forwarded to L4.
Definition: socket.h:1073
bool IsEnabled(void) const
Checks if the DF (Don&#39;t Fragment) flag is set.
Definition: socket.cc:738
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:767
static uint8_t IpTos2Priority(uint8_t ipTos)
Return the priority corresponding to a given TOS value.
Definition: socket.cc:408
This class implements a tag that carries the socket-specific TTL of a packet to the IP layer...
Definition: socket.h:1111
bool NotifyConnectionRequest(const Address &from)
Notify through the callback (if set) that an incoming connection is being requested by a remote host...
Definition: socket.cc:257
Ipv6Address m_ipv6MulticastGroupAddress
IPv6 multicast group address.
Definition: socket.h:1074
bool m_ipRecvTos
socket forwards IPv4 TOS tag to L4
Definition: socket.h:1091
Object to create transport layer instances that provide a socket API to applications.
bool IsRecvPktInfo() const
Get status indicating whether enable/disable packet information to socket.
Definition: socket.cc:364
TAG_BUFFER_INLINE uint8_t ReadU8(void)
Definition: tag-buffer.h:195
uint8_t m_ipv6Tclass
the socket IPv6 Tclass
Definition: socket.h:1103
a polymophic address class
Definition: address.h:90
bool IsIpRecvTos(void) const
Ask if the socket is currently passing information about IP Type of Service up the stack...
Definition: socket.cc:471
void SetRecvPktInfo(bool flag)
Enable/Disable receive packet information to socket.
Definition: socket.cc:358
Ptr< NetDevice > GetBoundNetDevice()
Returns socket&#39;s bound NetDevice, if any.
Definition: socket.cc:351
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
Ipv6MulticastFilterMode
Enumeration of the possible filter of a socket.
Definition: socket.h:138
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:889
#define max(a, b)
Definition: 80211b.c:43
uint8_t GetTclass(void) const
Get the tag&#39;s Tclass.
Definition: socket.cc:912
void SetTtl(uint8_t ttl)
Set the tag&#39;s TTL.
Definition: socket.cc:610
uint8_t m_ipTos
the socket IPv4 TOS
Definition: socket.h:1094
uint8_t m_priority
the socket priority
Definition: socket.h:1087
Callback< void, Ptr< Socket > > m_receivedData
data received callback
Definition: socket.h:1085
Callback< void, Ptr< Socket >, const Address & > m_newConnectionCreated
connection created callback
Definition: socket.h:1082
indicates whether the socket has a priority set.
Definition: socket.h:1303
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:803
Ptr< NetDevice > GetDevice(uint32_t index) const
Retrieve the index-th NetDevice associated to this node.
Definition: node.cc:142
Callback< void, Ptr< Socket > > m_connectionFailed
connection failed callback
Definition: socket.h:1078
bool IsManualIpv6Tclass(void) const
Checks if the socket has a specific IPv6 Tclass set.
Definition: socket.cc:371
void NotifyDataSent(uint32_t size)
Notify through the callback (if set) that some data have been sent.
Definition: socket.cc:285
virtual ~Socket(void)
Definition: socket.cc:65
void SetRecvCallback(Callback< void, Ptr< Socket > >)
Notify application when new data is available to be read.
Definition: socket.cc:128
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:71
virtual void Print(std::ostream &os) const
Definition: socket.cc:779
virtual enum Socket::SocketType GetSocketType(void) const =0
void SetHopLimit(uint8_t hopLimit)
Set the tag&#39;s Hop Limit.
Definition: socket.cc:671
void NotifyConnectionSucceeded(void)
Notify through the callback (if set) that the connection has been established.
Definition: socket.cc:217
Callback< void, Ptr< Socket > > m_errorClose
connection closed due to errors callback
Definition: socket.h:1080
uint32_t GetNDevices(void) const
Definition: node.cc:150
Callback< void, Ptr< Socket >, uint32_t > m_dataSent
data sent callback
Definition: socket.h:1083
bool IsManualIpv6HopLimit(void) const
Checks if the socket has a specific IPv6 Hop Limit set.
Definition: socket.cc:383
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:642
void NotifyNormalClose(void)
Notify through the callback (if set) that the connection has been closed.
Definition: socket.cc:237
tag a set of bytes in a packet
Definition: tag.h:36
uint8_t m_ipTtl
the socket IPv4 TTL
Definition: socket.h:1095
void SetIpv6Tclass(int ipTclass)
Manually set IPv6 Traffic Class field.
Definition: socket.cc:477
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:706
address
Definition: first.py:37
void NotifyNewConnectionCreated(Ptr< Socket > socket, const Address &from)
Notify through the callback (if set) that a new connection has been created.
Definition: socket.cc:275
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:701
indicates whether the socket has IPV6_TCLASS set.
Definition: socket.h:1350
uint8_t GetIpv6Tclass(void) const
Query the value of IPv6 Traffic Class field of this socket.
Definition: socket.cc:501
virtual void Ipv6LeaveGroup(void)
Leaves IPv6 multicast group this socket is joined to.
Definition: socket.cc:586
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:860
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:37
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:929
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:773
TAG_BUFFER_INLINE void WriteU8(uint8_t v)
Definition: tag-buffer.h:172
bool IsIpv6RecvTclass(void) const
Ask if the socket is currently passing information about IPv6 Traffic Class up the stack...
Definition: socket.cc:513
uint8_t GetPriority(void) const
Get the tag&#39;s priority.
Definition: socket.cc:854
void SetSendCallback(Callback< void, Ptr< Socket >, uint32_t > sendCb)
Notify application when space in transmit buffer is added.
Definition: socket.cc:121
bool m_ipRecvTtl
socket forwards IPv4 TTL tag to L4
Definition: socket.h:1092
void SetAcceptCallback(Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated)
Accept connection requests from remote hosts.
Definition: socket.cc:104
virtual void BindToNetDevice(Ptr< NetDevice > netdevice)
Bind a socket to specific device.
Definition: socket.cc:330
virtual void Print(std::ostream &os) const
Definition: socket.cc:895
void SetDataSentCallback(Callback< void, Ptr< Socket >, uint32_t > dataSent)
Notify application when a packet has been sent from transport protocol (non-standard socket call) ...
Definition: socket.cc:114
virtual void DoDispose(void)
Destructor implementation.
Definition: socket.cc:315
bool IsIpRecvTtl(void) const
Ask if the socket is currently passing information about IP_TTL up the stack.
Definition: socket.cc:538
static TypeId GetTypeId(void)
Get the type ID.
Definition: socket.cc:685
uint8_t GetHopLimit(void) const
Get the tag&#39;s Hop Limit.
Definition: socket.cc:677
void Disable(void)
Disables the DF (Don&#39;t Fragment) flag.
Definition: socket.cc:732
Describes an IPv6 address.
Definition: ipv6-address.h:49
read and write tag data
Definition: tag-buffer.h:51
Ptr< NetDevice > m_boundnetdevice
the device this socket is bound to (might be null).
Definition: socket.h:1072
void SetIpv6RecvHopLimit(bool ipv6RecvHopLimit)
Tells a socket to pass information about IPv6 Hop Limit up the stack.
Definition: socket.cc:557
Callback< void, Ptr< Socket > > m_normalClose
connection closed callback
Definition: socket.h:1079
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:935
void SetPriority(uint8_t priority)
Manually set the socket priority.
Definition: socket.cc:389
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:636
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:826
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:262
virtual Ptr< Node > GetNode(void) const =0
Return the node this socket is associated with.
virtual void Print(std::ostream &os) const
Definition: socket.cc:837
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:711
indicates whether packets should be sent out with the DF (Don&#39;t Fragment) flag set.
Definition: socket.h:1207
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:648
void SetIpRecvTtl(bool ipv4RecvTtl)
Tells a socket to pass information about IP_TTL up the stack.
Definition: socket.cc:532
void Enable(void)
Enables the DF (Don&#39;t Fragment) flag.
Definition: socket.cc:726
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:654
uint32_t CopyData(uint8_t *buffer, uint32_t size) const
Copy the packet contents to a byte buffer.
Definition: packet.cc:378
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
virtual void Deserialize(TagBuffer i)
Definition: socket.cc:832
virtual void Print(std::ostream &os) const
Definition: socket.cc:716
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:254
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:871
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:84
A base class which provides memory management and object aggregation.
Definition: object.h:87
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.
uint8_t GetTtl(void) const
Get the tag&#39;s TTL.
Definition: socket.cc:617
Callback< void, Ptr< Socket >, uint32_t > m_sendCb
packet sent callback
Definition: socket.h:1084
virtual int Send(Ptr< Packet > p, uint32_t flags)=0
Send data (or dummy data) to the remote host.
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:756
virtual void SetIpv6HopLimit(uint8_t ipHopLimit)
Manually set IPv6 Hop Limit.
Definition: socket.cc:544
void SetPriority(uint8_t priority)
Set the tag&#39;s priority.
Definition: socket.cc:848
virtual uint32_t GetSerializedSize(void) const
Definition: socket.cc:820
virtual void Serialize(TagBuffer i) const
Definition: socket.cc:883
uint8_t GetPriority(void) const
Query the priority value of this socket.
Definition: socket.cc:402
indicates whether the socket has IP_TOS set.
Definition: socket.h:1257
void SetIpTos(uint8_t ipTos)
Manually set IP Type of Service field.
Definition: socket.cc:443
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: socket.cc:695
a unique identifier for an interface.
Definition: type-id.h:58
void NotifySend(uint32_t spaceAvailable)
Notify through the callback (if set) that some data have been sent.
Definition: socket.cc:295
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
bool m_manualIpTtl
socket has IPv4 TTL set
Definition: socket.h:1090
void NotifyErrorClose(void)
Notify through the callback (if set) that the connection has been closed due to an error...
Definition: socket.cc:247
virtual void SetIpTtl(uint8_t ipTtl)
Manually set IP Time to Live field.
Definition: socket.cc:519
bool m_ipv6RecvHopLimit
socket forwards IPv6 Hop Limit tag to L4
Definition: socket.h:1101
bool m_manualIpv6Tclass
socket has IPv6 Tclass set
Definition: socket.h:1098
bool m_ipv6RecvTclass
socket forwards IPv6 Tclass tag to L4
Definition: socket.h:1100