blob: f89c7d3698112971a39b8cc48c99dce1e8ee51f5 [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 Afanasyevc74a6022011-08-15 20:01:35 -070033/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070034 * \ingroup ndn-helpers
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070035 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070036 * \brief Class implementing functionality to detect Ndn packet type and
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070037 * create the corresponding object
38 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070039 * Ndn doesn't really have a header, so we need this class to
40 * determine type of Ndn packet and return corresponent header class,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070041 * InterestHeader or ContentObjectHeader
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070042 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070043 * Throws UnknownHeaderException if header type couldn't be determined
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070044 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045class HeaderHelper
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070046{
47public:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070048 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070049 @brief enum for Ndn packet types
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070050 */
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080051 enum Type {INTEREST_CCNB, CONTENT_OBJECT_CCNB,
52 INTEREST_NDNSIM, CONTENT_OBJECT_NDNSIM};
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070053
54 /**
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080055 * Packet ::= Version
56 * PacketType
57 * (Interest | ContentObject)
58 *
59 * 0 1
60 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
61 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
62 * | Version | PacketType |
63 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64 *
65 * For ccnb-encoding compatibility, ``Version`` / ``PacketType`` has two reserved values to denote ccnb-encoded packet:
66 *
67 * Version 0x01, PacketType 0xD2 --- ccnb-encoded ``Interest`` packet
68 * Version 0x04, PacketType 0x82 --- ccnb-encoded ``ContentObject`` packet
69 *
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070070 *
71 * It peeks first 2 bytes of a packet.
72 *
73 * All interests start with
74 * +-----------------+ +---+---------+-------+
75 * | 0 0 0 0 0 0 0 1 | | 1 | 1 0 1 0 | 0 1 0 | (0x01 0xD2)
76 * +-----------------+ +---+---------+-------+
77 *
78 * All content objects start with
79 * +-----------------+ +---+---------+-------+
80 * | 0 0 0 0 0 1 0 0 | | 1 | 0 0 0 0 | 0 1 0 | (0x04 0x82)
81 * +-----------------+ +---+---------+-------+
82 * ^ ^^^^^
83 * | |
84 * terminator DTAG (Dictionary TAG)
85 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070086 * \see http://www.ndn.org/releases/latest/doc/technical/BinaryEncoding.html
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070087 */
88
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -070089 static Type
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070090 GetNdnHeaderType (Ptr<const Packet> packet);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070091};
92
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070093 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070094 * \ingroup ndn
95 * \defgroup ndn-exceptions Exceptions
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070096 */
97 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070098 * \ingroup ndn-exceptions
99 * \brief Exception thrown if Ndn stack receives unrecognized
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700100 * message type
101 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700102class UnknownHeaderException {};
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700103
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700104} // namespace ndn
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700105} // namespace ns3
106
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700107#endif // _NDN_HEADER_HELPER_H_