management: Making LocalControlHeader encoding independent of Interest/Data wire
Boost.Asio support multi-buffer send operation, which is enabled in this
commit for prepending (potentially different) LocalControlHeader's to
Interest/Data wire.
Change-Id: I39b979f89f196d3e47d6466fb71f6d440bce74d4
refs: #1265
diff --git a/src/data.hpp b/src/data.hpp
index 508c332..5130b03 100644
--- a/src/data.hpp
+++ b/src/data.hpp
@@ -280,7 +280,7 @@
EncodingEstimator estimator;
size_t estimatedSize = wireEncode(estimator);
- EncodingBuffer buffer(estimatedSize + nfd::ESTIMATED_LOCAL_HEADER_RESERVE, 0);
+ EncodingBuffer buffer(estimatedSize, 0);
wireEncode(buffer);
const_cast<Data*>(this)->wireDecode(buffer.block());
@@ -479,6 +479,7 @@
Data::setIncomingFaceId(uint64_t incomingFaceId)
{
getLocalControlHeader().setIncomingFaceId(incomingFaceId);
+ // ! do not reset Data's wire !
}
inline void
diff --git a/src/encoding/block.cpp b/src/encoding/block.cpp
index 37b2e6f..3451ffd 100644
--- a/src/encoding/block.cpp
+++ b/src/encoding/block.cpp
@@ -70,7 +70,8 @@
}
Block::Block(const ConstBufferPtr &buffer,
- const Buffer::const_iterator &begin, const Buffer::const_iterator &end)
+ const Buffer::const_iterator &begin, const Buffer::const_iterator &end,
+ bool verifyLength/* = true*/)
: m_buffer(buffer)
, m_begin(begin)
, m_end(end)
@@ -80,10 +81,13 @@
m_value_end = m_end;
m_type = Tlv::readType(m_value_begin, m_value_end);
- uint64_t length = Tlv::readVarNumber(m_value_begin, m_value_end);
- if (length != static_cast<uint64_t>(m_value_end - m_value_begin))
+ if (verifyLength)
{
- throw Tlv::Error("TLV length doesn't match buffer length");
+ uint64_t length = Tlv::readVarNumber(m_value_begin, m_value_end);
+ if (length != static_cast<uint64_t>(m_value_end - m_value_begin))
+ {
+ throw Tlv::Error("TLV length doesn't match buffer length");
+ }
}
}
diff --git a/src/encoding/block.hpp b/src/encoding/block.hpp
index 895df49..52ed7e7 100644
--- a/src/encoding/block.hpp
+++ b/src/encoding/block.hpp
@@ -56,7 +56,8 @@
* This version will automatically detect type and position of the value within the block
*/
Block(const ConstBufferPtr &buffer,
- const Buffer::const_iterator &begin, const Buffer::const_iterator &end);
+ const Buffer::const_iterator &begin, const Buffer::const_iterator &end,
+ bool verifyLength = true);
/**
* @brief A helper version of a constructor to create Block from the raw buffer (type and value-length parsing)
diff --git a/src/encoding/encoding-buffer.hpp b/src/encoding/encoding-buffer.hpp
index 1659c52..b46225b 100644
--- a/src/encoding/encoding-buffer.hpp
+++ b/src/encoding/encoding-buffer.hpp
@@ -85,8 +85,15 @@
inline const uint8_t*
buf () const;
+ /**
+ * @brief Create Block from the underlying EncodingBuffer
+ *
+ * @param verifyLength If this parameter set to true, Block's constructor
+ * will be requested to verify consistency of the encoded
+ * length in the Block, otherwise ignored
+ */
inline Block
- block () const;
+ block (bool verifyLength = true) const;
inline void
resize (size_t sz, bool addInFront);
@@ -218,10 +225,11 @@
}
inline Block
-EncodingImpl<encoding::Buffer>::block () const
+EncodingImpl<encoding::Buffer>::block (bool verifyLength/* = true*/) const
{
return Block(m_buffer,
- m_begin, m_end);
+ m_begin, m_end,
+ verifyLength);
}
inline void
diff --git a/src/face.cpp b/src/face.cpp
index 3f95cf9..e362864 100644
--- a/src/face.cpp
+++ b/src/face.cpp
@@ -105,7 +105,16 @@
m_pendingInterestTable.push_back(shared_ptr<PendingInterest>(new PendingInterest
(interest, onData, onTimeout)));
- m_transport->send(interest->getLocalControlHeader().wireEncode(*interest));
+ if (!interest->getLocalControlHeader().empty(false, true))
+ {
+ // encode only NextHopFaceId towards the forwarder
+ m_transport->send(interest->getLocalControlHeader().wireEncode(*interest, false, true),
+ interest->wireEncode());
+ }
+ else
+ {
+ m_transport->send(interest->wireEncode());
+ }
if (!m_pitTimeoutCheckTimerActive) {
m_pitTimeoutCheckTimerActive = true;
@@ -121,7 +130,15 @@
m_transport->connect(*m_ioService,
bind(&Face::onReceiveElement, this, _1));
- m_transport->send(data.getLocalControlHeader().wireEncode(data));
+ if (!data.getLocalControlHeader().empty(false, true))
+ {
+ m_transport->send(data.wireEncode());
+ }
+ else
+ {
+ m_transport->send(data.getLocalControlHeader().wireEncode(data, false, true),
+ data.wireEncode());
+ }
}
void
diff --git a/src/interest.hpp b/src/interest.hpp
index a0d99d8..a22578f 100644
--- a/src/interest.hpp
+++ b/src/interest.hpp
@@ -157,7 +157,7 @@
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
- // Gettest/setters
+ // Getters/setters
const Name&
getName() const
@@ -267,6 +267,25 @@
setIncomingFaceId(uint64_t incomingFaceId)
{
getLocalControlHeader().setIncomingFaceId(incomingFaceId);
+ // ! do not reset Interest's wire !
+ return *this;
+ }
+
+ //
+
+ // NextHopFaceId helpers make sense only for Interests
+
+ uint64_t
+ getNextHopFaceId() const
+ {
+ return getLocalControlHeader().getNextHopFaceId();
+ }
+
+ Interest&
+ setNextHopFaceId(uint64_t nextHopFaceId)
+ {
+ getLocalControlHeader().setNextHopFaceId(nextHopFaceId);
+ // ! do not reset Interest's wire !
return *this;
}
@@ -447,7 +466,7 @@
EncodingEstimator estimator;
size_t estimatedSize = wireEncode(estimator);
- EncodingBuffer buffer(estimatedSize + nfd::ESTIMATED_LOCAL_HEADER_RESERVE, 0);
+ EncodingBuffer buffer(estimatedSize, 0);
wireEncode(buffer);
m_wire = buffer.block();
diff --git a/src/management/nfd-local-control-header.hpp b/src/management/nfd-local-control-header.hpp
index e931f57..5ddc14b 100644
--- a/src/management/nfd-local-control-header.hpp
+++ b/src/management/nfd-local-control-header.hpp
@@ -14,11 +14,12 @@
namespace nfd {
const uint64_t INVALID_FACE_ID = std::numeric_limits<uint64_t>::max();
-const size_t ESTIMATED_LOCAL_HEADER_RESERVE = 10;
class LocalControlHeader
{
public:
+ struct Error : public std::runtime_error { Error(const std::string &what) : std::runtime_error(what) {} };
+
LocalControlHeader()
: m_incomingFaceId(INVALID_FACE_ID)
, m_nextHopFaceId(INVALID_FACE_ID)
@@ -28,17 +29,26 @@
/**
* @brief Create wire encoding with options LocalControlHeader and the supplied item
*
- * This method will return wire encoding of the item if none of the LocalControlHeader
- * fields are set, otherwise it will encapsulate the item inside LocalControlHeader
+ * The caller is responsible of checking whether LocalControlHeader contains
+ * any information.
*
- * Note that this method will use default maximum packet size (8800 bytes) during the
- * encoding process.
+ * !It is an error to call this method if neither IncomingFaceId nor NextHopFaceId is
+ * set, or neither of them is enabled.
+ *
+ * @throws LocalControlHeader::Error when empty LocalControlHeader be produced
+ *
+ * @returns Block, containing LocalControlHeader. Top-level length field of the
+ * returned LocalControlHeader includes payload length, but the memory
+ * block is independent of the payload's wire buffer. It is expected
+ * that both LocalControlHeader's and payload's wire will be send out
+ * together within a single send call.
*
* @see http://redmine.named-data.net/projects/nfd/wiki/LocalControlHeader
*/
template<class U>
- inline const Block&
- wireEncode(const U& item) const;
+ inline Block
+ wireEncode(const U& payload,
+ bool encodeIncomingFaceId, bool encodeNextHopFaceId) const;
/**
* @brief Decode from the wire format and set LocalControlHeader on the supplied item
@@ -55,12 +65,13 @@
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
- // Gettest/setters
+ // Getters/setters
bool
- empty() const
+ empty(bool encodeIncomingFaceId, bool encodeNextHopFaceId) const
{
- return (!hasIncomingFaceId() && !hasNextHopFaceId());
+ return !((encodeIncomingFaceId && hasIncomingFaceId()) ||
+ (encodeNextHopFaceId && hasNextHopFaceId()));
}
//
@@ -81,7 +92,6 @@
setIncomingFaceId(uint64_t incomingFaceId)
{
m_incomingFaceId = incomingFaceId;
- m_wire.reset();
}
//
@@ -102,38 +112,37 @@
setNextHopFaceId(uint64_t nextHopFaceId)
{
m_nextHopFaceId = nextHopFaceId;
- m_wire.reset();
}
private:
- template<bool T, class U>
+ template<bool T>
inline size_t
- wireEncode(EncodingImpl<T>& block, const U& item) const;
+ wireEncode(EncodingImpl<T>& block, size_t payloadSize,
+ bool encodeIncomingFaceId, bool encodeNextHopFaceId) const;
private:
uint64_t m_incomingFaceId;
uint64_t m_nextHopFaceId;
-
- mutable Block m_wire;
};
/**
* @brief Fast encoding or block size estimation
*/
-template<bool T, class U>
+template<bool T>
inline size_t
-LocalControlHeader::wireEncode(EncodingImpl<T>& block, const U& item) const
+LocalControlHeader::wireEncode(EncodingImpl<T>& block, size_t payloadSize,
+ bool encodeIncomingFaceId, bool encodeNextHopFaceId) const
{
- size_t total_len = item.wireEncode().size();
+ size_t total_len = payloadSize;
- if (hasIncomingFaceId())
+ if (encodeIncomingFaceId && hasIncomingFaceId())
{
total_len += prependNonNegativeIntegerBlock(block,
tlv::nfd::IncomingFaceId, getIncomingFaceId());
}
- if (hasNextHopFaceId())
+ if (encodeNextHopFaceId && hasNextHopFaceId())
{
total_len += prependNonNegativeIntegerBlock(block,
tlv::nfd::NextHopFaceId, getNextHopFaceId());
@@ -145,58 +154,36 @@
}
template<class U>
-inline const Block&
-LocalControlHeader::wireEncode(const U& item) const
+inline Block
+LocalControlHeader::wireEncode(const U& payload,
+ bool encodeIncomingFaceId, bool encodeNextHopFaceId) const
{
- if (item.hasWire() && m_wire.hasWire())
- return m_wire;
+ /// @todo should this be BOOST_ASSERT instead? This is kind of unnecessary overhead
+ if (empty(encodeIncomingFaceId, encodeNextHopFaceId))
+ throw Error("Requested wire for LocalControlHeader, but none of the fields are set or enabled");
- if (empty())
- {
- if (item.hasWire())
- return item.wireEncode();
- else
- {
- EncodingBuffer buffer; // use default (maximum) packet size here
- item.wireEncode(buffer);
- item.m_wire = buffer.block();
- m_wire = buffer.block();
- }
- }
- else
- {
- if (item.hasWire())
- {
- // extend the existing buffer
- EncodingBuffer buffer(item.wireEncode());
- wireEncode(buffer, item);
- m_wire = buffer.block();
- }
- else
- {
- EncodingBuffer buffer;
- item.wireEncode(buffer);
- item.m_wire = buffer.block();
+ EncodingEstimator estimator;
+ size_t length = wireEncode(estimator, payload.wireEncode().size(),
+ encodeIncomingFaceId, encodeNextHopFaceId);
+
+ EncodingBuffer buffer(length);
+ wireEncode(buffer, payload.wireEncode().size(),
+ encodeIncomingFaceId, encodeNextHopFaceId);
- wireEncode(buffer, item);
- m_wire = buffer.block();
- }
- }
- return m_wire;
+ return buffer.block(false);
}
inline void
LocalControlHeader::wireDecode(const Block& wire)
{
BOOST_ASSERT(wire.type() == tlv::nfd::LocalControlHeader);
- m_wire = wire;
- m_wire.parse();
+ wire.parse();
m_incomingFaceId = INVALID_FACE_ID;
m_nextHopFaceId = INVALID_FACE_ID;
- for (Block::element_const_iterator i = m_wire.elements_begin();
- i != m_wire.elements_end();
+ for (Block::element_const_iterator i = wire.elements_begin();
+ i != wire.elements_end();
++i)
{
switch(i->type())
diff --git a/src/meta-info.hpp b/src/meta-info.hpp
index ff71570..2bccd37 100644
--- a/src/meta-info.hpp
+++ b/src/meta-info.hpp
@@ -45,7 +45,7 @@
wireDecode(const Block &wire);
///////////////////////////////////////////////////////////////////////////////
- // Gettest/setters
+ // Getters/setters
uint32_t
getType() const
diff --git a/src/transport/stream-transport.hpp b/src/transport/stream-transport.hpp
new file mode 100644
index 0000000..f98b988
--- /dev/null
+++ b/src/transport/stream-transport.hpp
@@ -0,0 +1,337 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
+/**
+ * Copyright (C) 2013-2014 Regents of the University of California.
+ * See COPYING for copyright and distribution information.
+ */
+
+#ifndef NDN_TRANSPORT_STREAM_TRANSPORT_HPP
+#define NDN_TRANSPORT_STREAM_TRANSPORT_HPP
+
+#include "../common.hpp"
+
+namespace ndn {
+
+const size_t MAX_LENGTH = 9000;
+
+template<class BaseTransport, class Protocol>
+class StreamTransportImpl
+{
+public:
+ typedef BaseTransport base_transport;
+ typedef Protocol protocol;
+ typedef StreamTransportImpl<BaseTransport,Protocol> impl;
+
+ StreamTransportImpl(base_transport& transport, boost::asio::io_service& ioService)
+ : m_transport(transport)
+ , m_socket(ioService)
+ , m_partialDataSize(0)
+ , m_connectionInProgress(false)
+ , m_connectTimer(ioService)
+ {
+ }
+
+ void
+ connectHandler(const boost::system::error_code& error)
+ {
+ m_connectionInProgress = false;
+ m_connectTimer.cancel();
+
+ if (!error)
+ {
+ m_partialDataSize = 0;
+ m_socket.async_receive(boost::asio::buffer(m_inputBuffer, MAX_LENGTH), 0,
+ bind(&impl::handle_async_receive, this, _1, _2));
+
+ m_transport.m_isConnected = true;
+
+ for (std::list<Block>::iterator i = m_sendQueue.begin(); i != m_sendQueue.end(); ++i)
+ m_socket.async_send(boost::asio::buffer(i->wire(), i->size()),
+ bind(&impl::handle_async_send, this, _1, *i));
+
+ for (std::list< std::pair<Block,Block> >::iterator i = m_sendPairQueue.begin();
+ i != m_sendPairQueue.end(); ++i)
+ {
+ std::vector<boost::asio::const_buffer> buffer;
+ buffer.reserve(2);
+ buffer.push_back(boost::asio::buffer(i->first.wire(), i->first.size()));
+ buffer.push_back(boost::asio::buffer(i->second.wire(), i->second.size()));
+ m_socket.async_send(buffer,
+ bind(&impl::handle_async_send, this, _1, i->first, i->second));
+ }
+
+ m_sendQueue.clear();
+ m_sendPairQueue.clear();
+ }
+ else
+ {
+ // may need to throw exception
+ m_transport.m_isConnected = false;
+ m_transport.close();
+ throw Transport::Error(error, "error while connecting to the forwarder");
+ }
+ }
+
+ void
+ connectTimeoutHandler(const boost::system::error_code& error)
+ {
+ if (error) // e.g., cancelled timer
+ return;
+
+ m_connectionInProgress = false;
+ m_transport.m_isConnected = false;
+ m_socket.close();
+ throw Transport::Error(error, "error while connecting to the forwarder");
+ }
+
+ void
+ connect(const typename protocol::endpoint& endpoint)
+ {
+ if (!m_connectionInProgress) {
+ m_connectionInProgress = true;
+
+ // Wait at most 4 seconds to connect
+ /// @todo Decide whether this number should be configurable
+ m_connectTimer.expires_from_now(boost::posix_time::seconds(4));
+ m_connectTimer.async_wait(bind(&impl::connectTimeoutHandler, this, _1));
+
+ m_socket.open();
+ m_socket.async_connect(endpoint,
+ bind(&impl::connectHandler, this, _1));
+ }
+ }
+
+ void
+ close()
+ {
+ m_connectTimer.cancel();
+ m_socket.close();
+ m_transport.m_isConnected = false;
+ m_sendQueue.clear();
+ m_sendPairQueue.clear();
+ }
+
+ void
+ send(const Block& wire)
+ {
+ if (!m_transport.m_isConnected)
+ m_sendQueue.push_back(wire);
+ else
+ m_socket.async_send(boost::asio::buffer(wire.wire(), wire.size()),
+ bind(&impl::handle_async_send, this, _1, wire));
+ }
+
+ void
+ send(const Block& header, const Block& payload)
+ {
+ if (!m_transport.m_isConnected)
+ {
+ m_sendPairQueue.push_back(std::make_pair(header, payload));
+ }
+ else
+ {
+ std::vector<boost::asio::const_buffer> buffers;
+ buffers.reserve(2);
+ buffers.push_back(boost::asio::buffer(header.wire(), header.size()));
+ buffers.push_back(boost::asio::buffer(payload.wire(), payload.size()));
+
+ m_socket.async_send(buffers,
+ bind(&impl::handle_async_send, this, _1, header, payload));
+ }
+ }
+
+ inline void
+ processAll(uint8_t* buffer, size_t& offset, size_t availableSize)
+ {
+ while(offset < availableSize)
+ {
+ Block element(buffer + offset, availableSize - offset);
+ m_transport.receive(element);
+
+ offset += element.size();
+ }
+ }
+
+ void
+ handle_async_receive(const boost::system::error_code& error, std::size_t bytes_recvd)
+ {
+ /// @todo The socket is not datagram, so need to have internal buffer to handle partial data reception
+
+ if (error)
+ {
+ if (error == boost::system::errc::operation_canceled) {
+ // async receive has been explicitly cancelled (e.g., socket close)
+ return;
+ }
+
+ m_socket.close(); // closing at this point may not be that necessary
+ m_transport.m_isConnected = true;
+ throw Transport::Error(error, "error while receiving data from socket");
+ }
+
+ if (!error && bytes_recvd > 0)
+ {
+ // m_inputBuffer has bytes_recvd received bytes of data
+ if (m_partialDataSize > 0)
+ {
+ size_t newDataSize = std::min(bytes_recvd, MAX_LENGTH-m_partialDataSize);
+ std::copy(m_inputBuffer, m_inputBuffer + newDataSize, m_partialData + m_partialDataSize);
+
+ m_partialDataSize += newDataSize;
+
+ size_t offset = 0;
+ try
+ {
+ processAll(m_partialData, offset, m_partialDataSize);
+
+ // no exceptions => processed the whole thing
+ if (bytes_recvd - newDataSize > 0)
+ {
+ // there is a little bit more data available
+
+ offset = 0;
+ m_partialDataSize = bytes_recvd - newDataSize;
+ std::copy(m_inputBuffer + newDataSize, m_inputBuffer + newDataSize + m_partialDataSize, m_partialData);
+
+ processAll(m_partialData, offset, m_partialDataSize);
+
+ // no exceptions => processed the whole thing
+ m_partialDataSize = 0;
+ }
+ else
+ {
+ // done processing
+ m_partialDataSize = 0;
+ }
+ }
+ catch(Tlv::Error &)
+ {
+ if (offset > 0)
+ {
+ m_partialDataSize -= offset;
+ std::copy(m_partialData + offset, m_partialData + offset + m_partialDataSize, m_partialData);
+ }
+ else if (offset == 0 && m_partialDataSize == MAX_LENGTH)
+ {
+ // very bad... should close connection
+ m_socket.close();
+ m_transport.m_isConnected = true;
+ throw Transport::Error(boost::system::error_code(),
+ "input buffer full, but a valid TLV cannot be decoded");
+ }
+ }
+ }
+ else
+ {
+ size_t offset = 0;
+ try
+ {
+ processAll(m_inputBuffer, offset, bytes_recvd);
+ }
+ catch(Tlv::Error &error)
+ {
+ if (offset > 0)
+ {
+ m_partialDataSize = bytes_recvd - offset;
+ std::copy(m_inputBuffer + offset, m_inputBuffer + offset + m_partialDataSize, m_partialData);
+ }
+ }
+ }
+ }
+
+ m_socket.async_receive(boost::asio::buffer(m_inputBuffer, MAX_LENGTH), 0,
+ bind(&impl::handle_async_receive, this, _1, _2));
+ }
+
+ void
+ handle_async_send(const boost::system::error_code& error, const Block& wire)
+ {
+ // pass (needed to keep data block alive during the send)
+ }
+
+ void
+ handle_async_send(const boost::system::error_code& error,
+ const Block& header, const Block& payload)
+ {
+ // pass (needed to keep data blocks alive during the send)
+ }
+
+protected:
+ base_transport& m_transport;
+
+ typename protocol::socket m_socket;
+ uint8_t m_inputBuffer[MAX_LENGTH];
+
+ uint8_t m_partialData[MAX_LENGTH];
+ size_t m_partialDataSize;
+
+ std::list< Block > m_sendQueue;
+ std::list< std::pair<Block, Block> > m_sendPairQueue;
+ bool m_connectionInProgress;
+
+ boost::asio::deadline_timer m_connectTimer;
+};
+
+
+template<class BaseTransport, class Protocol>
+class StreamTransportWithResolverImpl : public StreamTransportImpl<BaseTransport, Protocol>
+{
+public:
+ typedef BaseTransport base_transport;
+ typedef Protocol protocol;
+ typedef StreamTransportWithResolverImpl<BaseTransport,Protocol> impl;
+
+ StreamTransportWithResolverImpl(base_transport& transport, boost::asio::io_service& ioService)
+ : StreamTransportImpl<base_transport, protocol>(transport, ioService)
+ {
+ }
+
+ void
+ resolveHandler(const boost::system::error_code& error,
+ typename protocol::resolver::iterator endpoint,
+ const shared_ptr<typename protocol::resolver>&)
+ {
+ if (error)
+ {
+ if (error == boost::system::errc::operation_canceled)
+ return;
+
+ throw Transport::Error(error, "Error during resolution of host or port");
+ }
+
+ typename protocol::resolver::iterator end;
+ if (endpoint == end)
+ {
+ this->m_connectionInProgress = false;
+ this->m_transport.m_isConnected = false;
+ this->m_socket.close();
+ throw Transport::Error(error, "Unable to resolve because host or port");
+ }
+
+ this->m_socket.async_connect(*endpoint,
+ bind(&impl::connectHandler, this, _1));
+ }
+
+ void
+ connect(const typename protocol::resolver::query& query)
+ {
+ if (!this->m_connectionInProgress) {
+ this->m_connectionInProgress = true;
+
+ // Wait at most 4 seconds to connect
+ /// @todo Decide whether this number should be configurable
+ this->m_connectTimer.expires_from_now(boost::posix_time::seconds(4));
+ this->m_connectTimer.async_wait(bind(&impl::connectTimeoutHandler, this, _1));
+
+ // typename boost::asio::ip::basic_resolver< protocol > resolver;
+ shared_ptr<typename protocol::resolver> resolver =
+ make_shared<typename protocol::resolver>(boost::ref(this->m_socket.get_io_service()));
+
+ resolver->async_resolve(query, bind(&impl::resolveHandler, this, _1, _2, resolver));
+ }
+ }
+};
+
+
+} // namespace ndn
+
+#endif // NDN_TRANSPORT_STREAM_TRANSPORT_HPP
diff --git a/src/transport/tcp-transport.cpp b/src/transport/tcp-transport.cpp
index 3c773a8..24ec85c 100644
--- a/src/transport/tcp-transport.cpp
+++ b/src/transport/tcp-transport.cpp
@@ -1,271 +1,19 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
- * Copyright (C) 2013 Regents of the University of California.
- * @author: Jeff Thompson <jefft0@remap.ucla.edu>
+ * Copyright (C) 2013-2014 Regents of the University of California.
* See COPYING for copyright and distribution information.
*/
#include "common.hpp"
#include "tcp-transport.hpp"
-
-#if NDN_CPP_HAVE_CXX11
-// In the std library, the placeholders are in a different namespace than boost.
-using namespace ndn::func_lib::placeholders;
-#endif
-
-using namespace std;
-typedef boost::asio::ip::tcp protocol;
+#include "stream-transport.hpp"
namespace ndn {
-const size_t MAX_LENGTH = 9000;
-
-class TcpTransport::Impl
-{
-public:
- Impl(TcpTransport &transport)
- : transport_(transport)
- , socket_(*transport_.ioService_)
- , partialDataSize_(0)
- , connectionInProgress_(false)
- , connectTimer_(*transport_.ioService_)
- {
- }
-
- void
- connectHandler(const boost::system::error_code& error)
- {
- connectionInProgress_ = false;
- connectTimer_.cancel();
-
- if (!error)
- {
- partialDataSize_ = 0;
- socket_.async_receive(boost::asio::buffer(inputBuffer_, MAX_LENGTH), 0,
- func_lib::bind(&Impl::handle_async_receive, this, _1, _2));
-
- transport_.isConnected_ = true;
-
- for (std::list<Block>::iterator i = sendQueue_.begin(); i != sendQueue_.end(); ++i)
- socket_.async_send(boost::asio::buffer(i->wire(), i->size()),
- func_lib::bind(&Impl::handle_async_send, this, _1, *i));
-
- sendQueue_.clear();
- }
- else
- {
- // may need to throw exception
- transport_.isConnected_ = false;
- transport_.close();
- throw Transport::Error(error, "error while connecting to the forwarder");
- }
- }
-
- void
- connectTimeoutHandler(const boost::system::error_code& error)
- {
- if (error) // e.g., cancelled timer
- return;
-
- connectionInProgress_ = false;
- transport_.isConnected_ = false;
- socket_.close();
- throw Transport::Error(error, "error while connecting to the forwarder");
- }
-
- void
- resolveHandler(const boost::system::error_code& error,
- boost::asio::ip::tcp::resolver::iterator endpoint,
- const ptr_lib::shared_ptr<boost::asio::ip::tcp::resolver>&)
- {
- if (error)
- {
- if (error == boost::system::errc::operation_canceled)
- return;
-
- throw Transport::Error(error, "Error during resolution of host or port [" + transport_.host_ + ":" + transport_.port_ + "]");
- }
-
- boost::asio::ip::tcp::resolver::iterator end;
- if (endpoint == end)
- {
- connectionInProgress_ = false;
- transport_.isConnected_ = false;
- socket_.close();
- throw Transport::Error(error, "Unable to connect because host or port [" + transport_.host_ + ":" + transport_.port_ + "] cannot be resolved");
- }
-
- socket_.async_connect(*endpoint,
- func_lib::bind(&Impl::connectHandler, this, _1));
- }
-
- void
- connect()
- {
- if (!connectionInProgress_) {
- connectionInProgress_ = true;
-
- // Wait at most 4 seconds to connect
- /// @todo Decide whether this number should be configurable
- connectTimer_.expires_from_now(boost::posix_time::seconds(4));
- connectTimer_.async_wait(func_lib::bind(&Impl::connectTimeoutHandler, this, _1));
-
- using boost::asio::ip::tcp;
-
- ptr_lib::shared_ptr<tcp::resolver> resolver =
- ptr_lib::make_shared<tcp::resolver>(boost::ref(*transport_.ioService_));
-
- tcp::resolver::query query(transport_.host_, transport_.port_);
-
- resolver->async_resolve(query, func_lib::bind(&Impl::resolveHandler, this, _1, _2, resolver));
- }
- }
-
- void
- close()
- {
- connectTimer_.cancel();
- socket_.close();
- transport_.isConnected_ = false;
- }
-
- void
- send(const Block &wire)
- {
- if (!transport_.isConnected_)
- sendQueue_.push_back(wire);
- else
- socket_.async_send(boost::asio::buffer(wire.wire(), wire.size()),
- func_lib::bind(&Impl::handle_async_send, this, _1, wire));
- }
-
- inline void
- processAll(uint8_t *buffer, size_t &offset, size_t availableSize)
- {
- while(offset < availableSize)
- {
- Block element(buffer + offset, availableSize - offset);
- transport_.receive(element);
-
- offset += element.size();
- }
- }
-
- void
- handle_async_receive(const boost::system::error_code& error, std::size_t bytes_recvd)
- {
- /// @todo The socket is not datagram, so need to have internal buffer to handle partial data reception
-
- if (error)
- {
- if (error == boost::system::errc::operation_canceled) {
- // async receive has been explicitly cancelled (e.g., socket close)
- return;
- }
-
- socket_.close(); // closing at this point may not be that necessary
- transport_.isConnected_ = true;
- throw Transport::Error(error, "error while receiving data from socket");
- }
-
- if (!error && bytes_recvd > 0)
- {
- // inputBuffer_ has bytes_recvd received bytes of data
- if (partialDataSize_ > 0)
- {
- size_t newDataSize = std::min(bytes_recvd, MAX_LENGTH-partialDataSize_);
- std::copy(inputBuffer_, inputBuffer_ + newDataSize, partialData_ + partialDataSize_);
-
- partialDataSize_ += newDataSize;
-
- size_t offset = 0;
- try
- {
- processAll(partialData_, offset, partialDataSize_);
-
- // no exceptions => processed the whole thing
- if (bytes_recvd - newDataSize > 0)
- {
- // there is a little bit more data available
-
- offset = 0;
- partialDataSize_ = bytes_recvd - newDataSize;
- std::copy(inputBuffer_ + newDataSize, inputBuffer_ + newDataSize + partialDataSize_, partialData_);
-
- processAll(partialData_, offset, partialDataSize_);
-
- // no exceptions => processed the whole thing
- partialDataSize_ = 0;
- }
- else
- {
- // done processing
- partialDataSize_ = 0;
- }
- }
- catch(Tlv::Error &)
- {
- if (offset > 0)
- {
- partialDataSize_ -= offset;
- std::copy(partialData_ + offset, partialData_ + offset + partialDataSize_, partialData_);
- }
- else if (offset == 0 && partialDataSize_ == MAX_LENGTH)
- {
- // very bad... should close connection
- socket_.close();
- transport_.isConnected_ = true;
- throw Transport::Error(boost::system::error_code(), "input buffer full, but a valid TLV cannot be decoded");
- }
- }
- }
- else
- {
- size_t offset = 0;
- try
- {
- processAll(inputBuffer_, offset, bytes_recvd);
- }
- catch(Tlv::Error &error)
- {
- if (offset > 0)
- {
- partialDataSize_ = bytes_recvd - offset;
- std::copy(inputBuffer_ + offset, inputBuffer_ + offset + partialDataSize_, partialData_);
- }
- }
- }
- }
-
- socket_.async_receive(boost::asio::buffer(inputBuffer_, MAX_LENGTH), 0,
- func_lib::bind(&Impl::handle_async_receive, this, _1, _2));
- }
-
- void
- handle_async_send(const boost::system::error_code& error, const Block &wire)
- {
- // pass (needed to keep data block alive during the send)
- }
-
-private:
- TcpTransport &transport_;
-
- protocol::socket socket_;
- uint8_t inputBuffer_[MAX_LENGTH];
-
- uint8_t partialData_[MAX_LENGTH];
- size_t partialDataSize_;
-
- std::list< Block > sendQueue_;
- bool connectionInProgress_;
-
- boost::asio::deadline_timer connectTimer_;
-};
-
TcpTransport::TcpTransport(const std::string& host, const std::string& port/* = "6363"*/)
- : host_(host)
- , port_(port)
+ : m_host(host)
+ , m_port(port)
{
}
@@ -274,27 +22,36 @@
}
void
-TcpTransport::connect(boost::asio::io_service &ioService,
- const ReceiveCallback &receiveCallback)
+TcpTransport::connect(boost::asio::io_service& ioService,
+ const ReceiveCallback& receiveCallback)
{
- if (!static_cast<bool>(impl_)) {
+ if (!static_cast<bool>(m_impl)) {
Transport::connect(ioService, receiveCallback);
- impl_ = ptr_lib::make_shared<TcpTransport::Impl> (ptr_lib::ref(*this));
+ m_impl = make_shared<Impl> (boost::ref(*this),
+ boost::ref(ioService));
}
- impl_->connect();
+
+ boost::asio::ip::tcp::resolver::query query(m_host, m_port);
+ m_impl->connect(query);
}
void
-TcpTransport::send(const Block &wire)
+TcpTransport::send(const Block& wire)
{
- impl_->send(wire);
+ m_impl->send(wire);
+}
+
+void
+TcpTransport::send(const Block& header, const Block& payload)
+{
+ m_impl->send(header, payload);
}
void
TcpTransport::close()
{
- impl_->close();
+ m_impl->close();
}
-}
+} // namespace ndn
diff --git a/src/transport/tcp-transport.hpp b/src/transport/tcp-transport.hpp
index c2ba56e..b97e2a1 100644
--- a/src/transport/tcp-transport.hpp
+++ b/src/transport/tcp-transport.hpp
@@ -1,18 +1,24 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
- * Copyright (C) 2013 Regents of the University of California.
- * @author: Jeff Thompson <jefft0@remap.ucla.edu>
+ * Copyright (C) 2013-2014 Regents of the University of California.
* See COPYING for copyright and distribution information.
*/
-#ifndef NDN_TCP_TRANSPORT_HPP
-#define NDN_TCP_TRANSPORT_HPP
+#ifndef NDN_TRANSPORT_TCP_TRANSPORT_HPP
+#define NDN_TRANSPORT_TCP_TRANSPORT_HPP
#include "../common.hpp"
#include "transport.hpp"
+// forward declaration
+namespace boost { namespace asio { namespace ip { class tcp; } } }
+
namespace ndn {
-
+
+// forward declaration
+template<class T, class U> class StreamTransportImpl;
+template<class T, class U> class StreamTransportWithResolverImpl;
+
class TcpTransport : public Transport
{
public:
@@ -21,23 +27,28 @@
// from Transport
virtual void
- connect(boost::asio::io_service &ioService,
- const ReceiveCallback &receiveCallback);
+ connect(boost::asio::io_service& ioService,
+ const ReceiveCallback& receiveCallback);
virtual void
close();
virtual void
- send(const Block &wire);
-
-private:
- std::string host_;
- std::string port_;
+ send(const Block& wire);
- class Impl;
- ptr_lib::shared_ptr<Impl> impl_;
+ virtual void
+ send(const Block& header, const Block& payload);
+
+private:
+ std::string m_host;
+ std::string m_port;
+
+ typedef StreamTransportWithResolverImpl<TcpTransport, boost::asio::ip::tcp> Impl;
+ friend class StreamTransportImpl<TcpTransport, boost::asio::ip::tcp>;
+ friend class StreamTransportWithResolverImpl<TcpTransport, boost::asio::ip::tcp>;
+ shared_ptr< Impl > m_impl;
};
-}
+} // namespace ndn
-#endif // NDN_TCP_TRANSPORT_HPP
+#endif // NDN_TRANSPORT_TCP_TRANSPORT_HPP
diff --git a/src/transport/transport.hpp b/src/transport/transport.hpp
index 3b62a21..c309288 100644
--- a/src/transport/transport.hpp
+++ b/src/transport/transport.hpp
@@ -1,12 +1,11 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
* Copyright (C) 2013 Regents of the University of California.
- * @author: Jeff Thompson <jefft0@remap.ucla.edu>
* See COPYING for copyright and distribution information.
*/
-#ifndef NDN_TRANSPORT_HPP
-#define NDN_TRANSPORT_HPP
+#ifndef NDN_TRANSPORT_TRANSPORT_HPP
+#define NDN_TRANSPORT_TRANSPORT_HPP
#include "../common.hpp"
#include "../encoding/block.hpp"
@@ -32,44 +31,54 @@
* @throws If connection cannot be established
*/
inline virtual void
- connect(boost::asio::io_service &io_service,
- const ReceiveCallback &receiveCallback);
+ connect(boost::asio::io_service& io_service,
+ const ReceiveCallback& receiveCallback);
/**
* Close the connection.
*/
virtual void
- close() = 0;
+ close() =0;
/**
- * Set data to the host
+ * @brief Set data to the host
+ *
* @param data A pointer to the buffer of data to send.
* @param dataLength The number of bytes in data.
*/
virtual void
- send(const Block &wire) = 0;
+ send(const Block& wire) =0;
+ /**
+ * @brief Alternative version of sending data, applying scatter/gather I/O concept
+ *
+ * Two non-consecutive memory blocks will be send out together, e.g., as part of the
+ * same message in datagram-oriented transports.
+ */
+ virtual void
+ send(const Block& header, const Block& payload) =0;
+
inline bool
isConnected();
protected:
inline void
- receive(const Block &wire);
+ receive(const Block& wire);
protected:
- boost::asio::io_service *ioService_;
- bool isConnected_;
- ReceiveCallback receiveCallback_;
+ boost::asio::io_service* m_ioService;
+ bool m_isConnected;
+ ReceiveCallback m_receiveCallback;
};
inline
Transport::Transport()
- : ioService_(0)
- , isConnected_(false)
+ : m_ioService(0)
+ , m_isConnected(false)
{
}
-inline Transport::Error::Error(const boost::system::error_code &code, const std::string &msg)
+inline Transport::Error::Error(const boost::system::error_code& code, const std::string& msg)
: std::runtime_error(msg + (code.value() ? " (" + code.category().message(code.value()) + ")" : ""))
{
}
@@ -80,25 +89,25 @@
}
inline void
-Transport::connect(boost::asio::io_service &ioService,
- const ReceiveCallback &receiveCallback)
+Transport::connect(boost::asio::io_service& ioService,
+ const ReceiveCallback& receiveCallback)
{
- ioService_ = &ioService;
- receiveCallback_ = receiveCallback;
+ m_ioService = &ioService;
+ m_receiveCallback = receiveCallback;
}
inline bool
Transport::isConnected()
{
- return isConnected_;
+ return m_isConnected;
}
inline void
-Transport::receive(const Block &wire)
+Transport::receive(const Block& wire)
{
- receiveCallback_(wire);
+ m_receiveCallback(wire);
}
-}
+} // namespace ndn
-#endif
+#endif // NDN_TRANSPORT_TRANSPORT_HPP
diff --git a/src/transport/unix-transport.cpp b/src/transport/unix-transport.cpp
index 84424f3..f1e26ec 100644
--- a/src/transport/unix-transport.cpp
+++ b/src/transport/unix-transport.cpp
@@ -1,246 +1,28 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
- * Copyright (C) 2013 Regents of the University of California.
- * @author: Jeff Thompson <jefft0@remap.ucla.edu>
+ * Copyright (C) 2013-2014 Regents of the University of California.
* See COPYING for copyright and distribution information.
*/
#include "common.hpp"
#include "unix-transport.hpp"
+#include "stream-transport.hpp"
#include "../face.hpp"
-#include <cstdlib>
-
-using namespace std;
-typedef boost::asio::local::stream_protocol protocol;
namespace ndn {
-const size_t MAX_LENGTH = 9000;
-
-class UnixTransport::Impl
-{
-public:
- Impl(UnixTransport &transport)
- : transport_(transport)
- , socket_(*transport_.ioService_)
- , partialDataSize_(0)
- , connectionInProgress_(false)
- , connectTimer_(*transport_.ioService_)
- {
- }
-
- void
- connectHandler(const boost::system::error_code& error)
- {
- connectionInProgress_ = false;
- connectTimer_.cancel();
-
- if (!error)
- {
- partialDataSize_ = 0;
- socket_.async_receive(boost::asio::buffer(inputBuffer_, MAX_LENGTH), 0,
- func_lib::bind(&Impl::handle_async_receive, this, _1, _2));
-
- transport_.isConnected_ = true;
-
- for (std::list<Block>::iterator i = sendQueue_.begin(); i != sendQueue_.end(); ++i)
- socket_.async_send(boost::asio::buffer(i->wire(), i->size()),
- func_lib::bind(&Impl::handle_async_send, this, _1, *i));
-
- sendQueue_.clear();
- }
- else
- {
- // may need to throw exception
- transport_.isConnected_ = false;
- transport_.close();
- throw Transport::Error(error, "error while connecting to the forwarder");
- }
- }
-
- void
- connectTimeoutHandler(const boost::system::error_code& error)
- {
- if (error) // e.g., cancelled timer
- return;
-
- connectionInProgress_ = false;
- transport_.isConnected_ = false;
- socket_.close();
- throw Transport::Error(error, "error while connecting to the forwarder");
- }
-
- void
- connect()
- {
- if (!connectionInProgress_) {
- connectionInProgress_ = true;
-
- // Wait at most 4 seconds to connect
- /// @todo Decide whether this number should be configurable
- connectTimer_.expires_from_now(boost::posix_time::seconds(4));
- connectTimer_.async_wait(func_lib::bind(&Impl::connectTimeoutHandler, this, _1));
-
- socket_.open();
- socket_.async_connect(protocol::endpoint(transport_.unixSocket_),
- func_lib::bind(&Impl::connectHandler, this, _1));
- }
- }
-
- void
- close()
- {
- connectTimer_.cancel();
- socket_.close();
- transport_.isConnected_ = false;
- }
-
- void
- send(const Block& wire)
- {
- if (!transport_.isConnected_)
- sendQueue_.push_back(wire);
- else
- socket_.async_send(boost::asio::buffer(wire.wire(), wire.size()),
- func_lib::bind(&Impl::handle_async_send, this, _1, wire));
- }
-
- inline void
- processAll(uint8_t* buffer, size_t& offset, size_t availableSize)
- {
- while(offset < availableSize)
- {
- Block element(buffer + offset, availableSize - offset);
- transport_.receive(element);
-
- offset += element.size();
- }
- }
-
- void
- handle_async_receive(const boost::system::error_code& error, std::size_t bytes_recvd)
- {
- /// @todo The socket is not datagram, so need to have internal buffer to handle partial data reception
-
- if (error)
- {
- if (error == boost::system::errc::operation_canceled) {
- // async receive has been explicitly cancelled (e.g., socket close)
- return;
- }
-
- socket_.close(); // closing at this point may not be that necessary
- transport_.isConnected_ = true;
- throw Transport::Error(error, "error while receiving data from socket");
- }
-
- if (!error && bytes_recvd > 0)
- {
- // inputBuffer_ has bytes_recvd received bytes of data
- if (partialDataSize_ > 0)
- {
- size_t newDataSize = std::min(bytes_recvd, MAX_LENGTH-partialDataSize_);
- std::copy(inputBuffer_, inputBuffer_ + newDataSize, partialData_ + partialDataSize_);
-
- partialDataSize_ += newDataSize;
-
- size_t offset = 0;
- try
- {
- processAll(partialData_, offset, partialDataSize_);
-
- // no exceptions => processed the whole thing
- if (bytes_recvd - newDataSize > 0)
- {
- // there is a little bit more data available
-
- offset = 0;
- partialDataSize_ = bytes_recvd - newDataSize;
- std::copy(inputBuffer_ + newDataSize, inputBuffer_ + newDataSize + partialDataSize_, partialData_);
-
- processAll(partialData_, offset, partialDataSize_);
-
- // no exceptions => processed the whole thing
- partialDataSize_ = 0;
- }
- else
- {
- // done processing
- partialDataSize_ = 0;
- }
- }
- catch(Tlv::Error &)
- {
- if (offset > 0)
- {
- partialDataSize_ -= offset;
- std::copy(partialData_ + offset, partialData_ + offset + partialDataSize_, partialData_);
- }
- else if (offset == 0 && partialDataSize_ == MAX_LENGTH)
- {
- // very bad... should close connection
- socket_.close();
- transport_.isConnected_ = true;
- throw Transport::Error(boost::system::error_code(), "input buffer full, but a valid TLV cannot be decoded");
- }
- }
- }
- else
- {
- size_t offset = 0;
- try
- {
- processAll(inputBuffer_, offset, bytes_recvd);
- }
- catch(Tlv::Error &error)
- {
- if (offset > 0)
- {
- partialDataSize_ = bytes_recvd - offset;
- std::copy(inputBuffer_ + offset, inputBuffer_ + offset + partialDataSize_, partialData_);
- }
- }
- }
- }
-
- socket_.async_receive(boost::asio::buffer(inputBuffer_, MAX_LENGTH), 0,
- func_lib::bind(&Impl::handle_async_receive, this, _1, _2));
- }
-
- void
- handle_async_send(const boost::system::error_code& error, const Block &wire)
- {
- // pass (needed to keep data block alive during the send)
- }
-
-private:
- UnixTransport &transport_;
-
- protocol::socket socket_;
- uint8_t inputBuffer_[MAX_LENGTH];
-
- uint8_t partialData_[MAX_LENGTH];
- size_t partialDataSize_;
-
- std::list< Block > sendQueue_;
- bool connectionInProgress_;
-
- boost::asio::deadline_timer connectTimer_;
-};
-
-
UnixTransport::UnixTransport()
{
if (std::getenv("NFD") != 0)
- unixSocket_ = "/var/run/nfd.sock";
+ m_unixSocket = "/var/run/nfd.sock";
else
- unixSocket_ = "/tmp/.ndnd.sock";
+ m_unixSocket = "/tmp/.ndnd.sock";
}
UnixTransport::UnixTransport(const std::string& unixSocket)
- : unixSocket_(unixSocket)
+ : m_unixSocket(unixSocket)
{
}
@@ -252,24 +34,32 @@
UnixTransport::connect(boost::asio::io_service& ioService,
const ReceiveCallback& receiveCallback)
{
- if (!static_cast<bool>(impl_)) {
+ if (!static_cast<bool>(m_impl)) {
Transport::connect(ioService, receiveCallback);
- impl_ = ptr_lib::make_shared<UnixTransport::Impl> (ptr_lib::ref(*this));
+ m_impl = make_shared<Impl> (boost::ref(*this),
+ boost::ref(ioService));
}
- impl_->connect();
+
+ m_impl->connect(boost::asio::local::stream_protocol::endpoint(m_unixSocket));
}
void
UnixTransport::send(const Block& wire)
{
- impl_->send(wire);
+ m_impl->send(wire);
+}
+
+void
+UnixTransport::send(const Block& header, const Block& payload)
+{
+ m_impl->send(header, payload);
}
void
UnixTransport::close()
{
- impl_->close();
+ m_impl->close();
}
}
diff --git a/src/transport/unix-transport.hpp b/src/transport/unix-transport.hpp
index dc85eac..4a89bc8 100644
--- a/src/transport/unix-transport.hpp
+++ b/src/transport/unix-transport.hpp
@@ -1,7 +1,6 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/**
- * Copyright (C) 2013 Regents of the University of California.
- * @author: Jeff Thompson <jefft0@remap.ucla.edu>
+ * Copyright (C) 2013-2014 Regents of the University of California.
* See COPYING for copyright and distribution information.
*/
@@ -11,8 +10,15 @@
#include "../common.hpp"
#include "transport.hpp"
+// forward declaration
+namespace boost { namespace asio { namespace local { class stream_protocol; } } }
+
namespace ndn {
+// forward declaration
+template<class T, class U>
+class StreamTransportImpl;
+
class UnixTransport : public Transport
{
public:
@@ -32,11 +38,15 @@
virtual void
send(const Block& wire);
+ virtual void
+ send(const Block& header, const Block& payload);
+
private:
- std::string unixSocket_;
+ std::string m_unixSocket;
- class Impl;
- ptr_lib::shared_ptr<Impl> impl_;
+ typedef StreamTransportImpl<UnixTransport, boost::asio::local::stream_protocol> Impl;
+ friend class StreamTransportImpl<UnixTransport, boost::asio::local::stream_protocol>;
+ ptr_lib::shared_ptr< Impl > m_impl;
};
}
diff --git a/tests/test-interest.cpp b/tests/test-interest.cpp
index ce7d56d..0c2db34 100644
--- a/tests/test-interest.cpp
+++ b/tests/test-interest.cpp
@@ -117,121 +117,105 @@
BOOST_AUTO_TEST_CASE(EncodeWithLocalHeader)
{
- {
- ndn::Interest i1(ndn::Name("/local/ndn/prefix"));
- i1.setMustBeFresh(true);
- i1.setIncomingFaceId(10);
- i1.setNonce(1);
+ ndn::Interest interest(ndn::Name("/local/ndn/prefix"));
+ interest.setMustBeFresh(true);
+ interest.setIncomingFaceId(10);
+ interest.setNonce(1);
- BOOST_CHECK(!i1.hasWire());
- const Block* block1 = &i1.getLocalControlHeader().wireEncode(i1);
+ BOOST_CHECK(!interest.hasWire());
- BOOST_CHECK_EQUAL(block1, &i1.getLocalControlHeader().wireEncode(i1));
- BOOST_CHECK(i1.hasWire());
- BOOST_CHECK_NE(block1, &i1.wireEncode());
- BOOST_CHECK_NE(block1->wire(), i1.wireEncode().wire());
- BOOST_CHECK_NE(block1->size(), i1.wireEncode().size());
+ Block headerBlock = interest.getLocalControlHeader().wireEncode(interest, true, true);
- BOOST_CHECK_EQUAL_COLLECTIONS(InterestWithLocalControlHeader,
- InterestWithLocalControlHeader+sizeof(InterestWithLocalControlHeader),
- block1->begin(), block1->end());
+ BOOST_CHECK(interest.hasWire());
+ BOOST_CHECK(headerBlock.hasWire());
- Block savedBlock1 = *block1;
+ BOOST_CHECK_NE(headerBlock.wire(), interest.wireEncode().wire());
+ BOOST_CHECK_NE(headerBlock.size(), interest.wireEncode().size());
+ BOOST_CHECK_EQUAL(headerBlock.size(), 5);
- i1.setNonce(1000);
- BOOST_CHECK(!i1.hasWire());
-
- const Block* block4 = &i1.getLocalControlHeader().wireEncode(i1);
- BOOST_CHECK_EQUAL(block4, &i1.getLocalControlHeader().wireEncode(i1));
- BOOST_CHECK_NE((void*)block4->wire(), (void*)savedBlock1.wire());
- BOOST_CHECK_NE(block4->size(), savedBlock1.size());
- }
+ BOOST_CHECK_EQUAL_COLLECTIONS(InterestWithLocalControlHeader,
+ InterestWithLocalControlHeader+5,
+ headerBlock.begin(), headerBlock.end());
- {
- ndn::Interest i1(ndn::Name("/local/ndn/prefix"));
- i1.setMustBeFresh(true);
- i1.setIncomingFaceId(10);
- i1.setNonce(1);
- i1.wireEncode(); // Encode with reserve for LocalControlHeader
+ interest.setNonce(1000);
- const void* savedWire = i1.wireEncode().wire();
- const Block* block1 = &i1.getLocalControlHeader().wireEncode(i1);
+ Block updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, true, true);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 5);
- BOOST_CHECK_EQUAL((const void*)i1.wireEncode().wire(), savedWire);
- BOOST_CHECK_EQUAL(i1.wireEncode().wire() - block1->wire(), 5);
- }
+ // only length should have changed
+ BOOST_CHECK_EQUAL_COLLECTIONS(updatedHeaderBlock.begin()+2, updatedHeaderBlock.end(),
+ headerBlock.begin()+2, headerBlock.end());
- {
- ndn::Interest i1(ndn::Name("/local/ndn/prefix"));
- i1.setMustBeFresh(true);
- i1.setIncomingFaceId(10);
- i1.setNonce(1);
+ // updating IncomingFaceId that keeps the length
+ interest.setIncomingFaceId(100);
+ updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, true, true);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 5);
+ BOOST_CHECK_NE(*(updatedHeaderBlock.begin()+4), *(headerBlock.begin()+4));
- EncodingBuffer buffer(31,0); // compared to previous version, there is not reserve for LocalControlHeader
- i1.wireEncode(buffer);
- i1.wireDecode(buffer.block());
+ // updating IncomingFaceId that increases the length by 2
+ interest.setIncomingFaceId(1000);
+ updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, true, true);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 6);
- const void* savedWire = i1.wireEncode().wire();
- const Block* block1 = &i1.getLocalControlHeader().wireEncode(i1);
+ // adding NextHopId
+ interest.setNextHopFaceId(1);
+ updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, true, true);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 9);
- BOOST_CHECK_EQUAL((const void*)i1.wireEncode().wire(), savedWire);
- BOOST_CHECK_NE(i1.wireEncode().wire() - block1->wire(), 5);
- }
-
- {
- ndn::Interest i2(ndn::Name("/local/ndn/prefix"));
- i2.setMustBeFresh(true);
- i2.setNonce(1);
+ // masking IncomingFaceId
+ updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, false, true);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 5);
- BOOST_CHECK(!i2.hasWire());
- const Block* block2 = &i2.getLocalControlHeader().wireEncode(i2);
- BOOST_CHECK_EQUAL(block2, &i2.getLocalControlHeader().wireEncode(i2));
- BOOST_CHECK(i2.hasWire());
- BOOST_CHECK_NE(block2, &i2.wireEncode());
- BOOST_CHECK_EQUAL(block2->wire(), i2.wireEncode().wire());
- BOOST_CHECK_EQUAL(block2->size(), i2.wireEncode().size());
+ // masking NextHopId
+ updatedHeaderBlock = interest.getLocalControlHeader().wireEncode(interest, true, false);
+ BOOST_CHECK_EQUAL(updatedHeaderBlock.size(), 6);
- Block savedBlock2 = *block2;
-
- BOOST_CHECK_EQUAL_COLLECTIONS(InterestWithoutLocalControlHeader,
- InterestWithoutLocalControlHeader+sizeof(InterestWithoutLocalControlHeader),
- block2->begin(), block2->end());
-
- i2.setNonce(1);
- BOOST_CHECK(!i2.hasWire());
-
- const Block* block4 = &i2.getLocalControlHeader().wireEncode(i2);
- BOOST_CHECK_EQUAL(block4, &i2.getLocalControlHeader().wireEncode(i2));
- BOOST_CHECK_NE((void*)block4->wire(), (void*)savedBlock2.wire());
- BOOST_CHECK_EQUAL(block4->size(), savedBlock2.size());
- }
+ // masking everything
+ BOOST_CHECK_THROW(interest.getLocalControlHeader().wireEncode(interest, false, false),
+ nfd::LocalControlHeader::Error);
}
+
BOOST_AUTO_TEST_CASE (DecodeWithLocalHeader)
{
- Block b1(InterestWithLocalControlHeader, sizeof(InterestWithLocalControlHeader));
- const Block& block1 = nfd::LocalControlHeader::getPayload(b1);
- BOOST_REQUIRE_NE(&block1, &b1);
+ Block wireBlock(InterestWithLocalControlHeader, sizeof(InterestWithLocalControlHeader));
+ const Block& payload = nfd::LocalControlHeader::getPayload(wireBlock);
+ BOOST_REQUIRE_NE(&payload, &wireBlock);
- BOOST_CHECK_EQUAL(block1.type(), (uint32_t)Tlv::Interest);
- BOOST_CHECK_EQUAL(b1.type(), (uint32_t)tlv::nfd::LocalControlHeader);
-
- Interest i(block1);
- BOOST_CHECK(!i.getLocalControlHeader().hasIncomingFaceId());
- BOOST_CHECK(!i.getLocalControlHeader().hasNextHopFaceId());
-
- BOOST_REQUIRE_NO_THROW(i.getLocalControlHeader().wireDecode(b1));
-
- BOOST_CHECK_EQUAL(i.getIncomingFaceId(), 10);
- BOOST_CHECK(!i.getLocalControlHeader().hasNextHopFaceId());
-
- BOOST_CHECK_EQUAL((void*)i.getLocalControlHeader().wireEncode(i).wire(), (void*)b1.wire());
-
- //
+ BOOST_CHECK_EQUAL(payload.type(), (uint32_t)Tlv::Interest);
+ BOOST_CHECK_EQUAL(wireBlock.type(), (uint32_t)tlv::nfd::LocalControlHeader);
- Block b2(InterestWithoutLocalControlHeader, sizeof(InterestWithoutLocalControlHeader));
- const Block& block2 = nfd::LocalControlHeader::getPayload(b2);
- BOOST_CHECK_EQUAL(&block2, &b2);
+ Interest interest(payload);
+ BOOST_CHECK(!interest.getLocalControlHeader().hasIncomingFaceId());
+ BOOST_CHECK(!interest.getLocalControlHeader().hasNextHopFaceId());
+
+ BOOST_REQUIRE_NO_THROW(interest.getLocalControlHeader().wireDecode(wireBlock));
+
+ BOOST_CHECK_EQUAL(interest.getLocalControlHeader().wireEncode(interest, true, true).size(), 5);
+
+ BOOST_CHECK_EQUAL(interest.getIncomingFaceId(), 10);
+ BOOST_CHECK(!interest.getLocalControlHeader().hasNextHopFaceId());
+
+ BOOST_CHECK_THROW(interest.getLocalControlHeader().wireEncode(interest, false, false),
+ nfd::LocalControlHeader::Error);
+
+ BOOST_CHECK_THROW(interest.getLocalControlHeader().wireEncode(interest, false, true),
+ nfd::LocalControlHeader::Error);
+
+ BOOST_CHECK_NO_THROW(interest.getLocalControlHeader().wireEncode(interest, true, false));
+ BOOST_CHECK_NO_THROW(interest.getLocalControlHeader().wireEncode(interest, true, true));
+
+ BOOST_CHECK_NE((void*)interest.getLocalControlHeader().wireEncode(interest, true, true).wire(),
+ (void*)wireBlock.wire());
+
+ BOOST_CHECK_EQUAL(interest.getLocalControlHeader().wireEncode(interest, true, true).size(), 5);
+}
+
+BOOST_AUTO_TEST_CASE (DecodeWithoutLocalHeader)
+{
+ Block wireBlock(InterestWithoutLocalControlHeader, sizeof(InterestWithoutLocalControlHeader));
+ const Block& payload = nfd::LocalControlHeader::getPayload(wireBlock);
+ BOOST_CHECK_EQUAL(&payload, &wireBlock);
}
BOOST_AUTO_TEST_SUITE_END()