A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
trailer.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2005 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18
*/
19
20
#ifndef TRAILER_H
21
#define TRAILER_H
22
23
#include "
buffer.h
"
24
#include "
chunk.h
"
25
26
#include <stdint.h>
27
28
namespace
ns3
29
{
30
31
/**
32
* \ingroup packet
33
*
34
* \brief Protocol trailer serialization and deserialization.
35
*
36
* Every Protocol trailer which needs to be inserted or removed
37
* from a Packet instance must derive from this base class and
38
* implement the pure virtual methods defined here.
39
*/
40
class
Trailer
:
public
Chunk
41
{
42
public
:
43
/**
44
* \brief Get the type ID.
45
* \return the object TypeId
46
*/
47
static
TypeId
GetTypeId
();
48
~Trailer
()
override
;
49
/**
50
* \returns the expected size of the trailer.
51
*
52
* This method is used by Packet::AddTrailer
53
* to store a trailer into the byte buffer of a packet. This method
54
* should return the number of bytes which are needed to store
55
* the full trailer data by Serialize.
56
*/
57
virtual
uint32_t
GetSerializedSize
()
const
= 0;
58
/**
59
* \param start an iterator which points to where the trailer
60
* should be written.
61
*
62
* This method is used by Packet::AddTrailer to
63
* store a header into the byte buffer of a packet.
64
* The data written is expected to match bit-for-bit the
65
* representation of this trailer in real networks.
66
* The input iterator points to the end of the area where the
67
* data shall be written. This method is thus expected to call
68
* Buffer::Iterator::Prev prior to actually writing any data.
69
*/
70
virtual
void
Serialize
(
Buffer::Iterator
start)
const
= 0;
71
/**
72
* \param end an iterator which points to the end of the buffer
73
* where the trailer should be read from.
74
* \returns the number of bytes read.
75
*
76
* This method is used by Packet::RemoveTrailer to
77
* re-create a trailer from the byte buffer of a packet.
78
* The data read is expected to match bit-for-bit the
79
* representation of this trailer in real networks.
80
* The input iterator points to the end of the area where the
81
* data shall be read from. This method is thus expected to call
82
* Buffer::Iterator::Prev prior to actually reading any data.
83
*/
84
uint32_t
Deserialize
(
Buffer::Iterator
end)
override
= 0;
85
/**
86
* \param start an iterator which points to the start of the buffer
87
* where the trailer should be read from.
88
* \param end an iterator which points to the end of the buffer
89
* where the trailer should be read from.
90
* \returns the number of bytes read.
91
*
92
* This method is used by Packet::RemoveTrailer to
93
* re-create a trailer from the byte buffer of a packet.
94
* The data read is expected to match bit-for-bit the
95
* representation of this trailer in real networks.
96
* The input iterator end points to the end of the area where the
97
* data shall be read from.
98
*
99
* This variant should be provided by any variable-sized trailer subclass
100
* (i.e. if GetSerializedSize () does not return a constant).
101
*/
102
uint32_t
Deserialize
(
Buffer::Iterator
start,
Buffer::Iterator
end)
override
;
103
/**
104
* \param os output stream
105
* This method is used by Packet::Print to print the
106
* content of a trailer as ascii data to a c++ output stream.
107
* Although the trailer is free to format its output as it
108
* wishes, it is recommended to follow a few rules to integrate
109
* with the packet pretty printer: start with flags, small field
110
* values located between a pair of parens. Values should be separated
111
* by whitespace. Follow the parens with the important fields,
112
* separated by whitespace.
113
* i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5
114
*/
115
void
Print
(std::ostream& os)
const override
= 0;
116
};
117
118
/**
119
* \brief Stream insertion operator.
120
*
121
* \param os the stream
122
* \param trailer the trailer
123
* \returns a reference to the stream
124
*/
125
std::ostream&
operator<<
(std::ostream& os,
const
Trailer
& trailer);
126
127
}
// namespace ns3
128
129
#endif
/* TRAILER_H */
buffer.h
chunk.h
ns3::Buffer::Iterator
iterator in a Buffer instance
Definition:
buffer.h:100
ns3::Chunk
abstract base class for ns3::Header and ns3::Trailer
Definition:
chunk.h:36
ns3::Trailer
Protocol trailer serialization and deserialization.
Definition:
trailer.h:41
ns3::Trailer::~Trailer
~Trailer() override
Definition:
trailer.cc:31
ns3::Trailer::Serialize
virtual void Serialize(Buffer::Iterator start) const =0
ns3::Trailer::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
trailer.cc:37
ns3::Trailer::Print
void Print(std::ostream &os) const override=0
ns3::Trailer::Deserialize
uint32_t Deserialize(Buffer::Iterator end) override=0
ns3::Trailer::GetSerializedSize
virtual uint32_t GetSerializedSize() const =0
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
uint32_t
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::operator<<
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition:
angles.cc:159
src
network
model
trailer.h
Generated on Tue May 28 2024 23:38:37 for ns-3 by
1.9.6