doc/trace-source-list.h
changeset 1759 a7793aa3ef66
parent 1757 530d2e974eb2
parent 1541 fc95ffdef447
child 1760 15e9e94e7e2e
equal deleted inserted replaced
1757:530d2e974eb2 1759:a7793aa3ef66
     1 ///
       
     2 /// \ingroup TraceSourceList
       
     3 /// \brief send ipv4 packet to outgoing interface
       
     4 /// \param arg1 the trace context associated to the connected trace source.
       
     5 /// \param arg2 packet sent.
       
     6 /// \param arg3 index of output ipv4 interface.
       
     7 ///
       
     8 ///
       
     9 /// The path to this trace source is: /nodes/[0-n]/ipv4/tx.
       
    10 ///
       
    11 /// The following classes can be extracted from \p arg1 with 
       
    12 /// ns3::TraceContext::GetElement:
       
    13 ///  - ns3::NodeListIndex
       
    14 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
    15 void TraceSinkCallback0 (const TraceContext & arg1, const Packet & arg2, uint32_t arg3);
       
    16 
       
    17 ///
       
    18 /// \ingroup TraceSourceList
       
    19 /// \brief receive ipv4 packet from incoming interface
       
    20 /// \param arg1 the trace context associated to the connected trace source.
       
    21 /// \param arg2 packet received.
       
    22 /// \param arg3 index of input ipv4 interface.
       
    23 ///
       
    24 ///
       
    25 /// The path to this trace source is: /nodes/[0-n]/ipv4/rx.
       
    26 ///
       
    27 /// The following classes can be extracted from \p arg1 with 
       
    28 /// ns3::TraceContext::GetElement:
       
    29 ///  - ns3::NodeListIndex
       
    30 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
    31 void TraceSinkCallback1 (const TraceContext & arg1, const Packet & arg2, uint32_t arg3);
       
    32 
       
    33 ///
       
    34 /// \ingroup TraceSourceList
       
    35 /// \brief drop ipv4 packet
       
    36 /// \param arg1 the trace context associated to the connected trace source.
       
    37 /// \param arg2 packet dropped.
       
    38 ///
       
    39 ///
       
    40 /// The path to this trace source is: /nodes/[0-n]/ipv4/drop.
       
    41 ///
       
    42 /// The following classes can be extracted from \p arg1 with 
       
    43 /// ns3::TraceContext::GetElement:
       
    44 ///  - ns3::NodeListIndex
       
    45 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
    46 void TraceSinkCallback2 (const TraceContext & arg1, const Packet & arg2);
       
    47 
       
    48 ///
       
    49 /// \ingroup TraceSourceList
       
    50 /// \brief store packet in queue
       
    51 /// \param arg1 the trace context associated to the connected trace source.
       
    52 /// \param arg2 packet queued.
       
    53 ///
       
    54 ///
       
    55 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/queue/enqueue.
       
    56 ///
       
    57 /// The following classes can be extracted from \p arg1 with 
       
    58 /// ns3::TraceContext::GetElement:
       
    59 ///  - ns3::NodeListIndex
       
    60 ///  - ns3::NodeNetDeviceIndex
       
    61 ///  - ns3::QueueTraceType
       
    62 void TraceSinkCallback3 (const TraceContext & arg1, const Packet & arg2);
       
    63 
       
    64 ///
       
    65 /// \ingroup TraceSourceList
       
    66 /// \brief remove packet from queue
       
    67 /// \param arg1 the trace context associated to the connected trace source.
       
    68 /// \param arg2 packet dequeued.
       
    69 ///
       
    70 ///
       
    71 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/queue/dequeue.
       
    72 ///
       
    73 /// The following classes can be extracted from \p arg1 with 
       
    74 /// ns3::TraceContext::GetElement:
       
    75 ///  - ns3::NodeListIndex
       
    76 ///  - ns3::NodeNetDeviceIndex
       
    77 ///  - ns3::QueueTraceType
       
    78 void TraceSinkCallback4 (const TraceContext & arg1, const Packet & arg2);
       
    79 
       
    80 ///
       
    81 /// \ingroup TraceSourceList
       
    82 /// \brief drop packet from queue
       
    83 /// \param arg1 the trace context associated to the connected trace source.
       
    84 /// \param arg2 packet dropped.
       
    85 ///
       
    86 ///
       
    87 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/queue/drop.
       
    88 ///
       
    89 /// The following classes can be extracted from \p arg1 with 
       
    90 /// ns3::TraceContext::GetElement:
       
    91 ///  - ns3::NodeListIndex
       
    92 ///  - ns3::NodeNetDeviceIndex
       
    93 ///  - ns3::QueueTraceType
       
    94 void TraceSinkCallback5 (const TraceContext & arg1, const Packet & arg2);
       
    95 
       
    96 ///
       
    97 /// \ingroup TraceSourceList
       
    98 /// \brief receive MAC packet
       
    99 /// \param arg1 the trace context associated to the connected trace source.
       
   100 /// \param arg2 packet received.
       
   101 ///
       
   102 ///
       
   103 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/rx.
       
   104 ///
       
   105 /// The following classes can be extracted from \p arg1 with 
       
   106 /// ns3::TraceContext::GetElement:
       
   107 ///  - ns3::NodeListIndex
       
   108 ///  - ns3::NodeNetDeviceIndex
       
   109 ///  - ns3::PointToPointTraceType
       
   110 void TraceSinkCallback6 (const TraceContext & arg1, const Packet & arg2);
       
   111 
       
   112 ///
       
   113 /// \ingroup TraceSourceList
       
   114 /// \brief receive MAC packet
       
   115 /// \param arg1 the trace context associated to the connected trace source.
       
   116 /// \param arg2 packet received.
       
   117 ///
       
   118 ///
       
   119 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/rx.
       
   120 ///
       
   121 /// The following classes can be extracted from \p arg1 with 
       
   122 /// ns3::TraceContext::GetElement:
       
   123 ///  - ns3::NodeListIndex
       
   124 ///  - ns3::NodeNetDeviceIndex
       
   125 ///  - ns3::CsmaTraceType
       
   126 void TraceSinkCallback7 (const TraceContext & arg1, const Packet & arg2);
       
   127 
       
   128 ///
       
   129 /// \ingroup TraceSourceList
       
   130 /// \brief drop MAC packet
       
   131 /// \param arg1 the trace context associated to the connected trace source.
       
   132 /// \param arg2 packet dropped.
       
   133 ///
       
   134 ///
       
   135 /// The path to this trace source is: /nodes/[0-n]/devices/[0-n]/drop.
       
   136 ///
       
   137 /// The following classes can be extracted from \p arg1 with 
       
   138 /// ns3::TraceContext::GetElement:
       
   139 ///  - ns3::NodeListIndex
       
   140 ///  - ns3::NodeNetDeviceIndex
       
   141 ///  - ns3::CsmaTraceType
       
   142 void TraceSinkCallback8 (const TraceContext & arg1, const Packet & arg2);
       
   143 
       
   144 ///
       
   145 /// \ingroup TraceSourceList
       
   146 /// \brief The value of the speed vector changed
       
   147 /// \param arg1 the trace context associated to the connected trace source.
       
   148 /// \param arg2 the mobility model whose course changed.
       
   149 ///
       
   150 ///
       
   151 /// The path to this trace source is: /nodes/[0-n]/$MobilityModelNotifier/course-change.
       
   152 ///
       
   153 /// The following classes can be extracted from \p arg1 with 
       
   154 /// ns3::TraceContext::GetElement:
       
   155 ///  - ns3::NodeListIndex
       
   156 void TraceSinkCallback9 (const TraceContext & arg1, Ptr<const MobilityModel> arg2);
       
   157 
       
   158 ///
       
   159 /// \ingroup TraceSourceList
       
   160 /// \brief send ipv4 packet to outgoing interface
       
   161 /// \param arg1 the trace context associated to the connected trace source.
       
   162 /// \param arg2 packet sent.
       
   163 /// \param arg3 index of output ipv4 interface.
       
   164 ///
       
   165 ///
       
   166 /// The path to this trace source is: /nodes/[0-n]/$Ipv4L3Protocol/tx.
       
   167 ///
       
   168 /// The following classes can be extracted from \p arg1 with 
       
   169 /// ns3::TraceContext::GetElement:
       
   170 ///  - ns3::NodeListIndex
       
   171 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
   172 void TraceSinkCallback10 (const TraceContext & arg1, const Packet & arg2, uint32_t arg3);
       
   173 
       
   174 ///
       
   175 /// \ingroup TraceSourceList
       
   176 /// \brief receive ipv4 packet from incoming interface
       
   177 /// \param arg1 the trace context associated to the connected trace source.
       
   178 /// \param arg2 packet received.
       
   179 /// \param arg3 index of input ipv4 interface.
       
   180 ///
       
   181 ///
       
   182 /// The path to this trace source is: /nodes/[0-n]/$Ipv4L3Protocol/rx.
       
   183 ///
       
   184 /// The following classes can be extracted from \p arg1 with 
       
   185 /// ns3::TraceContext::GetElement:
       
   186 ///  - ns3::NodeListIndex
       
   187 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
   188 void TraceSinkCallback11 (const TraceContext & arg1, const Packet & arg2, uint32_t arg3);
       
   189 
       
   190 ///
       
   191 /// \ingroup TraceSourceList
       
   192 /// \brief drop ipv4 packet
       
   193 /// \param arg1 the trace context associated to the connected trace source.
       
   194 /// \param arg2 packet dropped.
       
   195 ///
       
   196 ///
       
   197 /// The path to this trace source is: /nodes/[0-n]/$Ipv4L3Protocol/drop.
       
   198 ///
       
   199 /// The following classes can be extracted from \p arg1 with 
       
   200 /// ns3::TraceContext::GetElement:
       
   201 ///  - ns3::NodeListIndex
       
   202 ///  - ns3::Ipv4L3ProtocolTraceContextElement
       
   203 void TraceSinkCallback12 (const TraceContext & arg1, const Packet & arg2);
       
   204