docs: Small update of the documentation
+ Adding reference to the used packet format to the TOC
diff --git a/docs/source/conf.py b/docs/source/conf.py
index aa315e9..4dddce1 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -41,14 +41,14 @@
# General information about the project.
project = u''
-copyright = u'2012, Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang'
+copyright = u'2011-2013 (c) Alexander Afanasyev, Ilya Moiseenko, and Lixia Zhang'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.1'
+version = '0.2.8'
# The full version, including alpha/beta/rc tags.
release = 'Overall ndnSIM'
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0a564d6..98c1f7b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -19,4 +19,7 @@
applications
examples
metric
+ ndnsim-packet-formats
faq
+
+* :ref:`search`
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index 62a12b2..1ef79b3 100644
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -58,10 +58,8 @@
...............................................................................
-The wire format of Interest and Data packets follows the format of the existing `CCNx Project's NDN implementation`_ (CCNx Binary Encoding), allowing reuse of the existing traffic analysis tools, as well as driving simulations using real NDN traffic traces.
-
-.. _CCNx Project's NDN implementation: http://www.ccnx.org/
-
+The current wire format for the Interest and Data packets used by ndnSIM is defined in :ref:`ndnSIM packet format`.
+ndnSIM also has an option to be compatible to wire format used by `CCNx Project's NDN implementation <http://www.ccnx.org/>`_ (CCNx Binary Encoding). However currently, this option is deprecated, but can be reintroduced in the future as an optional wire format.
More documentation
------------------
@@ -133,5 +131,3 @@
.. * :ref:`genindex`
.. * :ref:`modindex`
-.. * :ref:`search`
-
diff --git a/docs/source/ndnsim-packet-formats.rst b/docs/source/ndnsim-packet-formats.rst
new file mode 100644
index 0000000..e985f30
--- /dev/null
+++ b/docs/source/ndnsim-packet-formats.rst
@@ -0,0 +1,364 @@
+.. _ndnSIM packet format:
+
+ndnSIM packet format
+====================
+
+Basic field types
++++++++++++++++++
+
+::
+
+ uint8_t ::= 8-bit unsigned integer
+
+ uint16_t ::= 16-bit unsigned integer
+
+ uint32_t ::= 32-bit unsigned integer
+
+ CHAR ::= 8-bit binary data
+
+ Blob ::= Length CHAR{Length}
+
+ Length ::= uint16_t
+
+NDN Packet Type
++++++++++++++++
+
+::
+
+ Packet ::= Version
+ PacketType
+ (Interest | ContentObject)
+
+ 0 1
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Version | PacketType |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+For ccnb-encoding compatibility, ``Version`` / ``PacketType`` has two reserved values to denote ccnb-encoded packet:
+
+Version 0x01, PacketType 0xD2 --- ccnb-encoded ``Interest`` packet
+Version 0x04, PacketType 0x82 --- ccnb-encoded ``ContentObject`` packet
+
+
+Version
+~~~~~~~
+
+::
+
+ Version ::= uint8_t
+
+The current version of the packet format. Right only value 0x80 is allowed.
+
+PacketType
+~~~~~~~~~~
+
+::
+
+ PacketType ::= uint8_t
+
+In the current version, two packet types are defined:
+
+- ``Interest`` (``PacketType`` = 0)
+- ``ContentObject`` (``PacketType`` = 1)
+
+Any other value of PacketType is invalid and such a packet should be discarded.
+
+Interest
+++++++++
+
+The objective of the new format is to optimize encoding/decoding operations.
+
+::
+
+ Interest ::= Nonce
+ Scope
+ InterestLifetime
+ Name
+ Selectors
+ Options
+
+Minumum size of the Interest packet: 1 + 4 + 2 + 1 + (2 + 0) + (2 + 0) + (2 + 0) = 14
+
+Maximum size of the Interest packet: 1 + 4 + 2 + 1 + (2 + 65535) + (2 + 65535) + (2 + 65535) = 196619
+
+::
+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Nonce |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Scope | Reserved | InterestLifetime |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ Name ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ Selectors ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ Options ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+Nonce
+~~~~~
+
+::
+
+ Nonce ::= uint32_t
+
+Reserved
+~~~~~~~~
+
+::
+
+ Reserved := uint8_t
+
+Currently does not have meaning and should be zero
+
+InterestLifetime
+~~~~~~~~~~~~~~~~
+
+::
+
+ InterestLifetime := uint16_t
+
+Interest lifetime is specified in seconds. Max value is about 18 hours.
+
+Scope
+~~~~~
+
+::
+
+ Scope ::= uint8_t
+
+Scope 0 prevents propagation beyond the local ccnd (even to other applications on the same host). Scope 1 limits propagation to the applications on the originating host. Scope 2 limits propagation to no further than the next host.
+
+Name
+~~~~
+
+::
+
+ Name ::= Length (NameComponent)*
+
+ NameComponent ::= Blob
+
+
+Selectors
+~~~~~~~~~
+
+::
+
+ Selectors ::= Length (Selector)*
+
+ Selector ::= MinSuffixComponents | MaxSuffixComponents | Publisher | Exclude | ChildSelector | AnswerOriginKind
+
+All selectors are for now undefined
+
+Options
+~~~~~~~
+
+::
+
+ Options ::= Length (Option)*
+
+
+.. .................................................................................................. ..
+.. .................................................................................................. ..
+.. .................................................................................................. ..
+.. .................................................................................................. ..
+
+
+ContentObject
++++++++++++++
+
+::
+
+ ContentObject ::= Signature
+ Name
+ Content
+
+::
+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
+ ~ ~
+ ~ Signature ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ Name ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ Content ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+Signature
+~~~~~~~~~
+
+::
+
+ Signature ::= Length
+ SignatureType
+ <type-dependeds signature data>
+
+Length specifies cumulative size of SignatureInfo and SignatureBits. If SignatureType is not recognized, the received can either discard the packet or ignore the signature using Length field, specified combined length of SignatureType and SignatureType-dependent fields.
+
+::
+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | SignatureType |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ ~ ~
+ ~ <type-dependeds signature data> ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+SignatureType
+^^^^^^^^^^^^^
+
+::
+
+ SignatureType ::= uint16_t
+
+The current version specifies three type of signatures:
+
+- 0x0000: empty signature
+- 0x0001: SHA256 (not a real signature, but just a digest of the content)
+- 0x0002: SHA256withRSA (real public-key signature based on SHA-256 digest)
+
+Other values may be defined in future.
+
+- Values greater or equal to 0xFF00 are for experimental purposes (e.g., for simulations)
+
+<type-dependeds signature data>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
++-------------------+---------------------------+
+| SignatureType | SignatureData definition |
++===================+===========================+
+| 0 (empty) | empty sequence |
++-------------------+---------------------------+
+| 1 (sha256) | CHAR{32} |
++-------------------+---------------------------+
+| 2 (SHA256withRSA) | CHAR{32} KeyLocator |
++-------------------+---------------------------+
+
+KeyLocator
+^^^^^^^^^^
+
+::
+
+ KeyLocator ::= KeyLocatorType
+ (Key | Certificate | KeyName)
+
+ Key ::= Blob
+
+ Certificate ::= Blob
+
+ KeyName ::= Name
+
+
+Content
+^^^^^^^
+
+::
+
+ Content ::= Length
+ ContentInfo
+ ContentData
+
+Content length can be computed as: Length - (1 - ContentInfo.Length)
+
+::
+
+ 0 1 2 3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length | Length (content Info) |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Timestamp |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Freshness | Reserved |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ | Length (ContentInfoOptions) | |
+ |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
+ ~ ~
+ ~ ContentInfoOptions ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ ~ ~
+ ~ ContentData ~
+ | |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+ContentInfo
+^^^^^^^^^^^
+
+::
+
+ ContentInfo ::= Length
+ Timestamp
+ Freshness
+ ContentOptions
+
+Timestamp
+~~~~~~~~~
+
+::
+
+ Timestamp ::= uint32_t
+
+Timestamp specifies content generation time as Unix time timestamp (number of seconds since midnight 1/1/1970).
+
+Freshness
+~~~~~~~~~
+
+::
+
+ Freshness ::= uint16_t
+
+Freshness specifies time in seconds (since Timestamp) for which the content is considered valid.
+
+Value 0xFFFF means that content is always valid.
+
+
+ContentOptions
+~~~~~~~~~~~~~~
+
+::
+
+ ContentOptions ::= Length
+ ContentOption*
+
+ ContentOption ::= Type |
+ FinalBlockID
+
+
+Not currently defined
+
diff --git a/docs/source/new-packet-formats.rst b/docs/source/new-packet-formats.rst
index d773662..52bb816 100644
--- a/docs/source/new-packet-formats.rst
+++ b/docs/source/new-packet-formats.rst
@@ -1,360 +1,4 @@
+.. toctree::
+ :maxdepth: 4
-Basic field types
-+++++++++++++++++
-
-::
-
- uint8_t ::= 8-bit unsigned integer
-
- uint16_t ::= 16-bit unsigned integer
-
- uint32_t ::= 32-bit unsigned integer
-
- CHAR ::= 8-bit binary data
-
- Blob ::= Length CHAR{Length}
-
- Length ::= uint16_t
-
-NDN Packet Type
-+++++++++++++++
-
-::
-
- Packet ::= Version
- PacketType
- (Interest | ContentObject)
-
- 0 1
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Version | PacketType |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-For ccnb-encoding compatibility, ``Version`` / ``PacketType`` has two reserved values to denote ccnb-encoded packet:
-
-Version 0x01, PacketType 0xD2 --- ccnb-encoded ``Interest`` packet
-Version 0x04, PacketType 0x82 --- ccnb-encoded ``ContentObject`` packet
-
-
-Version
-=======
-
-::
-
- Version ::= uint8_t
-
-The current version of the packet format. Right only value 0x80 is allowed.
-
-PacketType
-==========
-
-::
-
- PacketType ::= uint8_t
-
-In the current version, two packet types are defined:
-
-- ``Interest`` (``PacketType`` = 0)
-- ``ContentObject`` (``PacketType`` = 1)
-
-Any other value of PacketType is invalid and such a packet should be discarded.
-
-Interest
-++++++++
-
-The objective of the new format is to optimize encoding/decoding operations.
-
-::
-
- Interest ::= Nonce
- Scope
- InterestLifetime
- Name
- Selectors
- Options
-
-Minumum size of the Interest packet: 1 + 4 + 2 + 1 + (2 + 0) + (2 + 0) + (2 + 0) = 14
-
-Maximum size of the Interest packet: 1 + 4 + 2 + 1 + (2 + 65535) + (2 + 65535) + (2 + 65535) = 196619
-
-::
-
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Nonce |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Scope | Reserved | InterestLifetime |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ Name ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ Selectors ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ Options ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Nonce
-=====
-
-::
-
- Nonce ::= uint32_t
-
-Reserved
-========
-
-::
-
- Reserved := uint8_t
-
-Currently does not have meaning and should be zero
-
-InterestLifetime
-================
-
-::
-
- InterestLifetime := uint16_t
-
-Interest lifetime is specified in seconds. Max value is about 18 hours.
-
-Scope
-=====
-
-::
-
- Scope ::= uint8_t
-
-Scope 0 prevents propagation beyond the local ccnd (even to other applications on the same host). Scope 1 limits propagation to the applications on the originating host. Scope 2 limits propagation to no further than the next host.
-
-Name
-====
-
-::
-
- Name ::= Length (NameComponent)*
-
- NameComponent ::= Blob
-
-
-Selectors
-=========
-
-::
-
- Selectors ::= Length (Selector)*
-
- Selector ::= MinSuffixComponents | MaxSuffixComponents | Publisher | Exclude | ChildSelector | AnswerOriginKind
-
-All selectors are for now undefined
-
-Options
-=======
-
-::
-
- Options ::= Length (Option)*
-
-
-.. .................................................................................................. ..
-.. .................................................................................................. ..
-.. .................................................................................................. ..
-.. .................................................................................................. ..
-
-
-ContentObject
-+++++++++++++
-
-::
-
- ContentObject ::= Signature
- Name
- Content
-
-::
-
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
- ~ ~
- ~ Signature ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ Name ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ Content ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-Signature
-=========
-
-::
-
- Signature ::= Length
- SignatureType
- <type-dependeds signature data>
-
-Length specifies cumulative size of SignatureInfo and SignatureBits. If SignatureType is not recognized, the received can either discard the packet or ignore the signature using Length field, specified combined length of SignatureType and SignatureType-dependent fields.
-
-::
-
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | SignatureType |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- ~ ~
- ~ <type-dependeds signature data> ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-SignatureType
-~~~~~~~~~~~~~
-
-::
-
- SignatureType ::= uint16_t
-
-The current version specifies three type of signatures:
-
-- 0x0000: empty signature
-- 0x0001: SHA256 (not a real signature, but just a digest of the content)
-- 0x0002: SHA256withRSA (real public-key signature based on SHA-256 digest)
-
-Other values may be defined in future.
-
-- Values greater or equal to 0xFF00 are for experimental purposes (e.g., for simulations)
-
-<type-dependeds signature data>
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-+-------------------+---------------------------+
-| SignatureType | SignatureData definition |
-+===================+===========================+
-| 0 (empty) | empty sequence |
-+-------------------+---------------------------+
-| 1 (sha256) | CHAR{32} |
-+-------------------+---------------------------+
-| 2 (SHA256withRSA) | CHAR{32} KeyLocator |
-+-------------------+---------------------------+
-
-KeyLocator
-~~~~~~~~~~
-
-::
-
- KeyLocator ::= KeyLocatorType
- (Key | Certificate | KeyName)
-
- Key ::= Blob
-
- Certificate ::= Blob
-
- KeyName ::= Name
-
-
-Content
-=======
-
-::
-
- Content ::= Length
- ContentInfo
- ContentData
-
-Content length can be computed as: Length - (1 - ContentInfo.Length)
-
-::
-
- 0 1 2 3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length | Length (content Info) |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Timestamp |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Freshness | Reserved |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- | Length (ContentInfoOptions) | |
- |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
- ~ ~
- ~ ContentInfoOptions ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
- ~ ~
- ~ ContentData ~
- | |
- +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-
-
-ContentInfo
-~~~~~~~~~~~
-
-::
-
- ContentInfo ::= Length
- Timestamp
- Freshness
- ContentOptions
-
-Timestamp
-=========
-
-::
-
- Timestamp ::= uint32_t
-
-Timestamp specifies content generation time as Unix time timestamp (number of seconds since midnight 1/1/1970).
-
-Freshness
-=========
-
-::
-
- Freshness ::= uint16_t
-
-Freshness specifies time in seconds (since Timestamp) for which the content is considered valid.
-
-Value 0xFFFF means that content is always valid.
-
-
-ContentOptions
-==============
-
-::
-
- ContentOptions ::= Length
- ContentOption*
-
- ContentOption ::= Type |
- FinalBlockID
-
-
-Not currently defined
-
+ ndnsim-packet-formats
diff --git a/examples/ndn-congestion-alt-topo-plugin.cc b/examples/ndn-congestion-alt-topo-plugin.cc
index 5d593f6..b591250 100644
--- a/examples/ndn-congestion-alt-topo-plugin.cc
+++ b/examples/ndn-congestion-alt-topo-plugin.cc
@@ -68,12 +68,12 @@
topologyReader.SetFileName ("src/ndnSIM/examples/topologies/topo-11-node-two-bottlenecks.txt");
topologyReader.Read ();
- // Install CCNx stack on all nodes
- ndn::StackHelper ccnxHelper;
- ccnxHelper.SetForwardingStrategy ("ns3::ndn::fw::CustomStrategy");
- ccnxHelper.SetContentStore ("ns3::ndn::cs::Lru",
+ // Install NDN stack on all nodes
+ ndn::StackHelper ndnHelper;
+ ndnHelper.SetForwardingStrategy ("ns3::ndn::fw::CustomStrategy");
+ ndnHelper.SetContentStore ("ns3::ndn::cs::Lru",
"MaxSize", "1"); // ! Attention ! If set to 0, then MaxSize is infinite
- ccnxHelper.InstallAll ();
+ ndnHelper.InstallAll ();
// Getting containers for the consumer/producer
Ptr<Node> consumers[4] = { Names::Find<Node> ("c1"), Names::Find<Node> ("c2"), Names::Find<Node> ("c3"), Names::Find<Node> ("c4") };
diff --git a/examples/ndn-congestion-topo-plugin.cc b/examples/ndn-congestion-topo-plugin.cc
index f80a816..77069ee 100644
--- a/examples/ndn-congestion-topo-plugin.cc
+++ b/examples/ndn-congestion-topo-plugin.cc
@@ -54,16 +54,16 @@
topologyReader.SetFileName ("src/ndnSIM/examples/topologies/topo-6-node.txt");
topologyReader.Read ();
- // Install CCNx stack on all nodes
- ndn::StackHelper ccnxHelper;
- ccnxHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
- ccnxHelper.SetContentStore ("ns3::ndn::cs::Lru",
+ // Install NDN stack on all nodes
+ ndn::StackHelper ndnHelper;
+ ndnHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
+ ndnHelper.SetContentStore ("ns3::ndn::cs::Lru",
"MaxSize", "10000");
- ccnxHelper.InstallAll ();
+ ndnHelper.InstallAll ();
// Installing global routing interface on all nodes
- ndn::GlobalRoutingHelper ccnxGlobalRoutingHelper;
- ccnxGlobalRoutingHelper.InstallAll ();
+ ndn::GlobalRoutingHelper ndnGlobalRoutingHelper;
+ ndnGlobalRoutingHelper.InstallAll ();
// Getting containers for the consumer/producer
Ptr<Node> consumer1 = Names::Find<Node> ("Src1");
@@ -90,18 +90,18 @@
// Register /dst1 prefix with global routing controller and
// install producer that will satisfy Interests in /dst1 namespace
- ccnxGlobalRoutingHelper.AddOrigins ("/dst1", producer1);
+ ndnGlobalRoutingHelper.AddOrigins ("/dst1", producer1);
producerHelper.SetPrefix ("/dst1");
producerHelper.Install (producer1);
// Register /dst2 prefix with global routing controller and
// install producer that will satisfy Interests in /dst2 namespace
- ccnxGlobalRoutingHelper.AddOrigins ("/dst2", producer2);
+ ndnGlobalRoutingHelper.AddOrigins ("/dst2", producer2);
producerHelper.SetPrefix ("/dst2");
producerHelper.Install (producer2);
// Calculate and install FIBs
- ccnxGlobalRoutingHelper.CalculateRoutes ();
+ ndn::GlobalRoutingHelper::CalculateRoutes ();
Simulator::Stop (Seconds (20.0));
diff --git a/examples/ndn-grid-topo-plugin.cc b/examples/ndn-grid-topo-plugin.cc
index 6d0e042..bbb8e86 100644
--- a/examples/ndn-grid-topo-plugin.cc
+++ b/examples/ndn-grid-topo-plugin.cc
@@ -58,21 +58,21 @@
topologyReader.SetFileName ("src/ndnSIM/examples/topologies/topo-grid-3x3.txt");
topologyReader.Read ();
- // Install CCNx stack on all nodes
- ndn::StackHelper ccnxHelper;
- ccnxHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
- ccnxHelper.InstallAll ();
+ // Install NDN stack on all nodes
+ ndn::StackHelper ndnHelper;
+ ndnHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
+ ndnHelper.InstallAll ();
// Installing global routing interface on all nodes
- ndn::GlobalRoutingHelper ccnxGlobalRoutingHelper;
- ccnxGlobalRoutingHelper.InstallAll ();
+ ndn::GlobalRoutingHelper ndnGlobalRoutingHelper;
+ ndnGlobalRoutingHelper.InstallAll ();
// Getting containers for the consumer/producer
Ptr<Node> producer = Names::Find<Node> ("Node8");
NodeContainer consumerNodes;
consumerNodes.Add (Names::Find<Node> ("Node0"));
- // Install CCNx applications
+ // Install NDN applications
std::string prefix = "/prefix";
ndn::AppHelper consumerHelper ("ns3::ndn::ConsumerCbr");
@@ -86,10 +86,10 @@
producerHelper.Install (producer);
// Add /prefix origins to ndn::GlobalRouter
- ccnxGlobalRoutingHelper.AddOrigins (prefix, producer);
+ ndnGlobalRoutingHelper.AddOrigins (prefix, producer);
// Calculate and install FIBs
- ccnxGlobalRoutingHelper.CalculateRoutes ();
+ ndn::GlobalRoutingHelper::CalculateRoutes ();
Simulator::Stop (Seconds (20.0));
diff --git a/examples/ndn-grid.cc b/examples/ndn-grid.cc
index 0651e22..8b75165 100644
--- a/examples/ndn-grid.cc
+++ b/examples/ndn-grid.cc
@@ -67,21 +67,21 @@
PointToPointGridHelper grid (3, 3, p2p);
grid.BoundingBox(100,100,200,200);
- // Install CCNx stack on all nodes
- ndn::StackHelper ccnxHelper;
- ccnxHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
- ccnxHelper.InstallAll ();
+ // Install NDN stack on all nodes
+ ndn::StackHelper ndnHelper;
+ ndnHelper.SetForwardingStrategy ("ns3::ndn::fw::BestRoute");
+ ndnHelper.InstallAll ();
// Installing global routing interface on all nodes
- ndn::GlobalRoutingHelper ccnxGlobalRoutingHelper;
- ccnxGlobalRoutingHelper.InstallAll ();
+ ndn::GlobalRoutingHelper ndnGlobalRoutingHelper;
+ ndnGlobalRoutingHelper.InstallAll ();
// Getting containers for the consumer/producer
Ptr<Node> producer = grid.GetNode (2, 2);
NodeContainer consumerNodes;
consumerNodes.Add (grid.GetNode (0,0));
- // Install CCNx applications
+ // Install NDN applications
std::string prefix = "/prefix";
ndn::AppHelper consumerHelper ("ns3::ndn::ConsumerCbr");
@@ -95,10 +95,10 @@
producerHelper.Install (producer);
// Add /prefix origins to ndn::GlobalRouter
- ccnxGlobalRoutingHelper.AddOrigins (prefix, producer);
+ ndnGlobalRoutingHelper.AddOrigins (prefix, producer);
// Calculate and install FIBs
- ccnxGlobalRoutingHelper.CalculateRoutes ();
+ ndn::GlobalRoutingHelper::CalculateRoutes ();
Simulator::Stop (Seconds (20.0));
diff --git a/examples/ndn-simple.cc b/examples/ndn-simple.cc
index 78993ee..dea70a0 100644
--- a/examples/ndn-simple.cc
+++ b/examples/ndn-simple.cc
@@ -66,10 +66,10 @@
p2p.Install (nodes.Get (0), nodes.Get (1));
p2p.Install (nodes.Get (1), nodes.Get (2));
- // Install CCNx stack on all nodes
- ndn::StackHelper ccnxHelper;
- ccnxHelper.SetDefaultRoutes (true);
- ccnxHelper.InstallAll ();
+ // Install NDN stack on all nodes
+ ndn::StackHelper ndnHelper;
+ ndnHelper.SetDefaultRoutes (true);
+ ndnHelper.InstallAll ();
// Installing applications