ns-3.24: src/common/packet.h@f860e6f94787 (annotated)

54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	1	/* -- Mode:C++; c-basic-offset:4; tab-width:4; indent-tabs-mode:f -- */
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	2	/*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	3	* Copyright (c) 2005,2006 INRIA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	4	* All rights reserved.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	5	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	6	* This program is free software; you can redistribute it and/or modify
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	7	* it under the terms of the GNU General Public License version 2 as
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	8	* published by the Free Software Foundation;
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	9	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	10	* This program is distributed in the hope that it will be useful,
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	13	* GNU General Public License for more details.
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	14	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	15	* You should have received a copy of the GNU General Public License
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	16	* along with this program; if not, write to the Free Software
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	18	*
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	19	* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	20	*/
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	21	#ifndef PACKET_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	22	#define PACKET_H
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	23
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	24	#include <stdint.h>
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	25	#include "buffer.h"
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	26	#include "chunk.h"
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	27	#include "tags.h"
14 6dd7d31c6fc3 replace yans include with ns3 include Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 9 diff changeset	28	#include "ns3/callback.h"
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	29
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 14 diff changeset	30	namespace ns3 {
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	31
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	32	class Packet {
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	33	public:
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	34	typedef Callback<void,uint8_t *,uint32_t> PacketReadWriteCallback;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	35	Packet ();
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	36	Packet (uint32_t size);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	37	Packet createFragment (uint32_t start, uint32_t length) const;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	38	uint32_t getSize (void) const;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	39	void add (Chunk *chunk);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	40	void peek (Chunk *chunk) const;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	41	void remove (Chunk *chunk);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	42	template <typename T>
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	43	void addTag (T const *tag);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	44	template <typename T>
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	45	bool removeTag (T *tag);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	46	template <typename T>
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	47	bool peekTag (T *tag) const;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	48	template <typename T>
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	49	bool updateTag (T const*tag);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	50	void removeAllTags (void);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	51	void write (PacketReadWriteCallback callback) const;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	52	void addAtEnd (Packet packet);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	53	void addAtEnd (Packet packet, uint32_t offset, uint32_t size);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	54	void removeAtEnd (uint32_t size);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	55	void removeAtStart (uint32_t size);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	56
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	57	private:
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	58	Packet (Buffer buffer, Tags tags);
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	59	Buffer m_buffer;
f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	60	Tags m_tags;
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	61	};
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	62
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 14 diff changeset	63	}; // namespace ns3
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	64
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 14 diff changeset	65	namespace ns3 {
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	66
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	67	template <typename T>
53 ae406f4957d5 variable/method/function coding style update Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	68	void Packet::addTag (T const*tag)
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	69	{
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	70	m_tags.add (tag);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	71	}
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	72	template <typename T>
53 ae406f4957d5 variable/method/function coding style update Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	73	bool Packet::removeTag (T *tag)
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	74	{
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	75	return m_tags.remove (tag);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	76	}
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	77	template <typename T>
53 ae406f4957d5 variable/method/function coding style update Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	78	bool Packet::peekTag (T *tag) const
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	79	{
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	80	return m_tags.peek (tag);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	81	}
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	82	template <typename T>
53 ae406f4957d5 variable/method/function coding style update Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 16 diff changeset	83	bool Packet::updateTag (T const*tag)
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	84	{
54 f860e6f94787 change indent to be 4 spaces Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 53 diff changeset	85	return m_tags.update (tag);
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	86	}
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	87
16 99e833adbb46 change yans namespace to ns3 Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: 14 diff changeset	88	}; // namespace ns3
9 2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	89
2c31ae7c94db import from yans Mathieu Lacage <mathieu.lacage@sophia.inria.fr> parents: diff changeset	90	#endif /* PACKET_H */

author	Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
	Tue, 05 Sep 2006 13:18:11 +0200
changeset 54	f860e6f94787
parent 53	ae406f4957d5
child 77	926e17b61dfb
permissions	-rw-r--r--