A Discrete-Event Network Simulator
API
flow-id-tag.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #include "flow-id-tag.h"
21 #include "ns3/log.h"
22 
23 namespace ns3 {
24 
25 NS_LOG_COMPONENT_DEFINE ("FlowIdTag");
26 
27 NS_OBJECT_ENSURE_REGISTERED (FlowIdTag);
28 
29 TypeId
31 {
32  static TypeId tid = TypeId ("ns3::FlowIdTag")
33  .SetParent<Tag> ()
34  .SetGroupName("Network")
35  .AddConstructor<FlowIdTag> ()
36  ;
37  return tid;
38 }
39 TypeId
41 {
42  return GetTypeId ();
43 }
44 uint32_t
46 {
47  NS_LOG_FUNCTION (this);
48  return 4;
49 }
50 void
52 {
53  NS_LOG_FUNCTION (this << &buf);
54  buf.WriteU32 (m_flowId);
55 }
56 void
58 {
59  NS_LOG_FUNCTION (this << &buf);
60  m_flowId = buf.ReadU32 ();
61 }
62 void
63 FlowIdTag::Print (std::ostream &os) const
64 {
65  NS_LOG_FUNCTION (this << &os);
66  os << "FlowId=" << m_flowId;
67 }
69  : Tag ()
70 {
71  NS_LOG_FUNCTION (this);
72 }
73 
74 FlowIdTag::FlowIdTag (uint32_t id)
75  : Tag (),
76  m_flowId (id)
77 {
78  NS_LOG_FUNCTION (this << id);
79 }
80 
81 void
82 FlowIdTag::SetFlowId (uint32_t id)
83 {
84  NS_LOG_FUNCTION (this << id);
85  m_flowId = id;
86 }
87 uint32_t
89 {
90  NS_LOG_FUNCTION (this);
91  return m_flowId;
92 }
93 
94 uint32_t
96 {
98  static uint32_t nextFlowId = 1;
99  uint32_t flowId = nextFlowId;
100  nextFlowId++;
101  return flowId;
102 }
103 
104 } // namespace ns3
105 
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
virtual uint32_t GetSerializedSize(void) const
Definition: flow-id-tag.cc:45
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
TAG_BUFFER_INLINE uint32_t ReadU32(void)
Definition: tag-buffer.h:215
static TypeId GetTypeId(void)
Get the type ID.
Definition: flow-id-tag.cc:30
TAG_BUFFER_INLINE void WriteU32(uint32_t v)
Definition: tag-buffer.h:186
virtual void Print(std::ostream &os) const
Definition: flow-id-tag.cc:63
virtual void Deserialize(TagBuffer buf)
Definition: flow-id-tag.cc:57
tag a set of bytes in a packet
Definition: tag.h:36
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void Serialize(TagBuffer buf) const
Definition: flow-id-tag.cc:51
read and write tag data
Definition: tag-buffer.h:51
Introspection did not find any typical Config paths.
Definition: flow-id-tag.h:27
static uint32_t AllocateFlowId(void)
Uses a static variable to generate sequential flow id.
Definition: flow-id-tag.cc:95
void SetFlowId(uint32_t flowId)
Sets the flow id for the tag.
Definition: flow-id-tag.cc:82
uint32_t GetFlowId(void) const
Gets the flow id for the tag.
Definition: flow-id-tag.cc:88
uint32_t m_flowId
Flow ID.
Definition: flow-id-tag.h:64
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: flow-id-tag.cc:40