Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-cxx / 933a567c8ac839a5d97c0f56675ede33ab2fc5b6 / . / docs / release-notes / release-notes-0.2.0.rst
blob: 85290240a822c6214a6c9b5fe0cd7a21316d481f [file] [log] [blame]
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]1ndn-cxx version 0.2.0
2---------------------
3
4Release date: August 25, 2014
5
6Changes since version 0.1.0:
7
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]8New features
9^^^^^^^^^^^^
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]10
11- **Base**
12
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]13 + The license under which the library is released is changed to the **GNU Lesser
14 General Public License version 3.0**
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]15
16 + New ways to use incoming Interest dispatching:
17
18 * New :ndn-cxx:`InterestFilter` abstraction that supports filtering based on name
19 prefixes and regular expressions.
20
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]21 * Separate ``Face::registerPrefix()`` and ``Face::setInterestFilter()`` methods
22 allow distinct operations of registering with the local NDN forwarder and setting
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]23 up application-specific ``OnInterest`` call dispatch using InterestFilters.
24
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]25 + Add support for the `NDN naming conventions (revision 1)
26 <https://named-data.net/publications/techreports/ndn-tr-22-ndn-memo-naming-conventions/>`_
27 (:issue:`1761`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]28
29- **Security**
30
31 + Add ``type dir`` :ref:`trust-anchor in ValidatorConfig <validator-conf-trust-anchors>`
32 to add all certificates under the specified directory as trust anchors.
33 The new option also allow periodic reloading trust anchors, allowing dynamic trust
34 models.
35
susmitf47cef62018-02-13 12:01:14 -0700[diff] [blame]36 + Added support for multiple signature types to ``PublicKey``, ``SecPublicInfo`` abstractions
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]37
38 + New :ndn-cxx:`SignatureSha256WithEcdsa` signature type
39
40 + Updates in :ndn-cxx:`Signature` data structure to reflect changes in `NDN-TLV spec
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]41 0.1.1 <https://named-data.net/doc/NDN-packet-spec/0.1.1/>`_
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]42
43- **Wire encoding**
44
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]45 + ``Data::getFullName()`` method to get the Data packet name including the implicit digest
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]46
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]47 + ``Name::getSuccessor()`` method to get name successor (:issue:`1677`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]48
49 + New in-wire refreshing of Interest's nonce (:issue:`1758`)
50
51- **Management**
52
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]53 + Support for :ndn-cxx:`ChannelStatus` and :ndn-cxx:`StrategyChoice` datasets
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]54
55 + Defining new common Route Origins for NFD RIB management protocol (:issue:`1719`)
56
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]57 + New ``RibEntry`` and ``Route`` data structures for RIB management protocol (:issue:`1764`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]58
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]59 + Add support for RIB flags in ``setInterestFilter()`` and ``registerPrefix()`` (:issue:`1842`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]60
61- **Miscellaneous tools**
62
63 + Introduce :ndn-cxx:`Scheduler::cancelAllEvents` to cancel all previously scheduled events
64 (:issue:`1757`)
65
susmitf47cef62018-02-13 12:01:14 -0700[diff] [blame]66 + Introduce ``util::EventEmitter``, :ndn-cxx:`util::NotificationSubscriber`,
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]67 :ndn-cxx:`util::NotificationStream`, and :ndn-cxx:`nfd::FaceMonitor` utility classes
68
69 + Introduce :ndn-cxx:`util::SegmentFetcher` helper class to fetch multi-segmented data
70 (:issue:`1879`)
71
72- **Build**
73
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]74 + Enabled support of precompiled headers for clang and gcc compilers to speed up compilation
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]75
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]76Updates and bug fixes
77^^^^^^^^^^^^^^^^^^^^^
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]78
79- **Base**
80
81 + Serialization of socket write operations (:issue:`1707`)
82
83 + Enforcing limit on Interest and Data packet size in :ndn-cxx:`Face::expressInterest` and
84 :ndn-cxx:`Face::put` methods (:issue:`1774`)
85
86 + Cleaning up transport state on communication failure, so Face can try to reconnect
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]87 in the future
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]88
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]89 + Fix bug in ``Face::removePendingInterest`` (:issue:`1917`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]90
91- **Wire encoding**
92
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]93 + The Nonce field is now encoded as a 4-byte value, as defined by NDN-TLV spec
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]94
95 + Optimized Data packet signing
96
97 :ndn-cxx:`KeyChain::sign` method now pre-allocates :ndn-cxx:`EncodingBuffer`, requests
98 unsigned portion of :ndn-cxx:`Data` using ``Data::wireEncode(EncodingBuffer, true)``,
99 and then appends the resulting signature and prepends :ndn-cxx:`Data` packet header.
100 This way there is no extra memory allocation after :ndn-cxx:`Data` packet is signed.
101
102 + Optimized implicit digest calculation in :ndn-cxx:`Interest::matchesData` method
103 (:issue:`1769`)
104
105- **Management**
106
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]107 + Add link-layer byte counts in ``FaceStatus`` data structure (:issue:`1765`)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]108
109- **Security**
110
111 + Allow user to explicitly specify the cert name prefix before 'KEY' component in
112 ``ndnsec-certgen``
113
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]114 + ``SignatureSha256`` has been renamed to :ndn-cxx:`DigestSha256` to conform to
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]115 `NDN-TLV specification <https://named-data.net/doc/NDN-packet-spec/0.1.1/>`_
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]116
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]117 + Add checking of Timestamp and Nonce fields in signed Interest within
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]118 :ndn-cxx:`ValidatorConfig`
119
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]120 + Allow validator customization using hooks.
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]121
122 Sub-classes of :ndn-cxx:`Validator` class can use the following hooks to fine-tune the
123 validation process:
124
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]125 * ``preCertificateValidation`` to process received certificate before validation
susmitf47cef62018-02-13 12:01:14 -0700[diff] [blame]126 * ``onTimeout`` to process interest timeout
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]127 * ``afterCheckPolicy`` to process validation requests
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]128
susmitf47cef62018-02-13 12:01:14 -0700[diff] [blame]129 + Fix memory issues in ``SecPublicInfoSqlite3``
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]130
131- **Miscellaneous tools**
132
133 + Redefine method for random number generation: ``random::generateWord*`` and
134 ``random::generateSecureWord*`` to generate cryptographically non-secure (fast) and
135 secure (slow) random numbers.
136
137- Other minor fixes and corrections
138
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]139Deprecated
140^^^^^^^^^^
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]141
142- ``SignatureSha256`` class, use :ndn-cxx:`DigestSha256` instead.
143
144- All :ndn-cxx:`Face` constructors that accept ``shared_ptr<io_service>``.
145
146 Use versions that accept reference to ``io_service`` object.
147
148- ``Face::ioService`` method, use :ndn-cxx:`Face::getIoService` instead.
149
150- :ndn-cxx:`Interest` constructor that accepts name, individual selectors, and individual
151 guiders as constructor parameters.
152
153 Use ``Interest().setX(...).setY(...)`` or use the overload taking ``Selectors``
154
155- ``name::Component::toEscapedString`` method, use :ndn-cxx:`name::Component::toUri` instead.
156
susmitf47cef62018-02-13 12:01:14 -0700[diff] [blame]157- ``SecPublicInfo::addPublicKey`` method, use ``SecPublicInfo::addKey`` instead.
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]158
159- ``Tlv::ConentType`` constant (typo), use ``Tlv::ContentType`` instead.
160
161- ``CommandInterestGenerator`` and ``CommandInterestValidator`` utility classes.
162 :ndn-cxx:`ValidatorConfig` should be used instead.
163
Davide Pesavento933a5672020-07-03 22:32:43 -0400[diff] [blame^]164Removed
165^^^^^^^
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]166
Davide Pesaventod776a932020-03-20 18:42:36 -0400[diff] [blame]167- Support for ndnd-tlv (only NFD management protocol is supported now)
Alexander Afanasyev45312f52015-09-27 12:06:50 -0700[diff] [blame]168
169- ``SecPublicInfoMemory`` and ``SecTpmMemory`` classes that were no longer used
170
171- Removing concept of periodic event from :ndn-cxx:`Scheduler`.
172
173 In applications, periodic events should be just re-scheduled within the callback for
174 single-shot events.