blob: a5a4d2fa1347deeb922b7b40b224d3569b051d5f [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2011 University of California, Los Angeles
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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070021#ifndef _NDN_HEADER_HELPER_H_
22#define _NDN_HEADER_HELPER_H_
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070023
24#include "ns3/ptr.h"
25
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070026namespace ns3 {
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070027
28class Header;
29class Packet;
30
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070031namespace ndn {
32
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080033class Name;
34
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070035/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070036 * \ingroup ndn-helpers
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070037 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070038 * \brief Class implementing functionality to detect Ndn packet type and
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070039 * create the corresponding object
40 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070041 * Ndn doesn't really have a header, so we need this class to
42 * determine type of Ndn packet and return corresponent header class,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070043 * InterestHeader or ContentObjectHeader
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070044 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045 * Throws UnknownHeaderException if header type couldn't be determined
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070046 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070047class HeaderHelper
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070048{
49public:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070050 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070051 @brief enum for Ndn packet types
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070052 */
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080053 enum Type {INTEREST_CCNB, CONTENT_OBJECT_CCNB,
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080054 INTEREST_NDNSIM, CONTENT_OBJECT_NDNSIM};
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070055
56 /**
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080057 * Packet ::= Version
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080058 * PacketType
59 * (Interest | ContentObject)
60 *
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080061 * 0 1
62 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080063 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64 * | Version | PacketType |
65 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66 *
67 * For ccnb-encoding compatibility, ``Version`` / ``PacketType`` has two reserved values to denote ccnb-encoded packet:
68 *
69 * Version 0x01, PacketType 0xD2 --- ccnb-encoded ``Interest`` packet
70 * Version 0x04, PacketType 0x82 --- ccnb-encoded ``ContentObject`` packet
71 *
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070072 *
73 * It peeks first 2 bytes of a packet.
74 *
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080075 * All interests start with
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070076 * +-----------------+ +---+---------+-------+
77 * | 0 0 0 0 0 0 0 1 | | 1 | 1 0 1 0 | 0 1 0 | (0x01 0xD2)
78 * +-----------------+ +---+---------+-------+
79 *
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080080 * All content objects start with
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070081 * +-----------------+ +---+---------+-------+
82 * | 0 0 0 0 0 1 0 0 | | 1 | 0 0 0 0 | 0 1 0 | (0x04 0x82)
83 * +-----------------+ +---+---------+-------+
84 * ^ ^^^^^
85 * | |
86 * terminator DTAG (Dictionary TAG)
87 *
Alexander Afanasyev9c0794a2012-12-10 01:02:33 -080088 * \see http://www.ccnx.org/releases/latest/doc/technical/BinaryEncoding.html
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070089 */
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080090
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -070091 static Type
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070092 GetNdnHeaderType (Ptr<const Packet> packet);
Alexander Afanasyevc45c4d62013-02-01 13:01:18 -080093
94 /**
95 * @brief A heavy-weight operation to get name of the packet
96 *
97 * This function returns name of the packet by deserializing a copy of the packet to a right header
98 */
99 static Ptr<const Name>
100 GetName (Ptr<const Packet> packet);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700101};
102
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700103 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700104 * \ingroup ndn
105 * \defgroup ndn-exceptions Exceptions
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700106 */
107 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700108 * \ingroup ndn-exceptions
109 * \brief Exception thrown if Ndn stack receives unrecognized
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700110 * message type
111 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700112class UnknownHeaderException {};
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700113
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700114} // namespace ndn
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700115} // namespace ns3
116
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700117#endif // _NDN_HEADER_HELPER_H_