blob: 713b801bd0f1ba8d59c9090906603496cd047bc2 [file] [log] [blame]
Junxiao Shicbba04c2014-01-26 14:21:22 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -07003 * Copyright (c) 2014 Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology
9 *
10 * This file is part of NFD (Named Data Networking Forwarding Daemon).
11 * See AUTHORS.md for complete list of NFD authors and contributors.
12 *
13 * NFD is free software: you can redistribute it and/or modify it under the terms
14 * of the GNU General Public License as published by the Free Software Foundation,
15 * either version 3 of the License, or (at your option) any later version.
16 *
17 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
18 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
19 * PURPOSE. See the GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License along with
22 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
23 **/
Junxiao Shicbba04c2014-01-26 14:21:22 -070024
25#ifndef NFD_TABLE_PIT_FACE_RECORD_HPP
26#define NFD_TABLE_PIT_FACE_RECORD_HPP
27
28#include "face/face.hpp"
Junxiao Shi408a7002014-02-12 17:53:47 -070029#include "strategy-info-host.hpp"
Junxiao Shicbba04c2014-01-26 14:21:22 -070030
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080031namespace nfd {
Junxiao Shicbba04c2014-01-26 14:21:22 -070032namespace pit {
33
34/** \class FaceRecord
35 * \brief contains information about an Interest
36 * on an incoming or outgoing face
37 * \note This is an implementation detail to extract common functionality
38 * of InRecord and OutRecord
39 */
Junxiao Shi408a7002014-02-12 17:53:47 -070040class FaceRecord : public StrategyInfoHost
Junxiao Shicbba04c2014-01-26 14:21:22 -070041{
42public:
43 explicit
44 FaceRecord(shared_ptr<Face> face);
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070045
Junxiao Shicbba04c2014-01-26 14:21:22 -070046 FaceRecord(const FaceRecord& other);
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070047
Junxiao Shicbba04c2014-01-26 14:21:22 -070048 shared_ptr<Face>
49 getFace() const;
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070050
Junxiao Shicbba04c2014-01-26 14:21:22 -070051 uint32_t
52 getLastNonce() const;
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070053
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070054 time::steady_clock::TimePoint
Junxiao Shicbba04c2014-01-26 14:21:22 -070055 getLastRenewed() const;
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070056
Junxiao Shicbba04c2014-01-26 14:21:22 -070057 /** \brief gives the time point this record expires
Junxiao Shif3c07812014-03-11 21:48:49 -070058 * \return getLastRenewed() + InterestLifetime
Junxiao Shicbba04c2014-01-26 14:21:22 -070059 */
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070060 time::steady_clock::TimePoint
Junxiao Shicbba04c2014-01-26 14:21:22 -070061 getExpiry() const;
62
63 /// updates lastNonce, lastRenewed, expiry fields
64 void
65 update(const Interest& interest);
66
67private:
68 shared_ptr<Face> m_face;
69 uint32_t m_lastNonce;
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070070 time::steady_clock::TimePoint m_lastRenewed;
71 time::steady_clock::TimePoint m_expiry;
Junxiao Shicbba04c2014-01-26 14:21:22 -070072};
73
74inline shared_ptr<Face>
75FaceRecord::getFace() const
76{
77 return m_face;
78}
79
80inline uint32_t
81FaceRecord::getLastNonce() const
82{
83 return m_lastNonce;
84}
85
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070086inline time::steady_clock::TimePoint
Junxiao Shicbba04c2014-01-26 14:21:22 -070087FaceRecord::getLastRenewed() const
88{
89 return m_lastRenewed;
90}
91
Alexander Afanasyeveb3197f2014-03-17 19:28:18 -070092inline time::steady_clock::TimePoint
Junxiao Shicbba04c2014-01-26 14:21:22 -070093FaceRecord::getExpiry() const
94{
95 return m_expiry;
96}
97
98} // namespace pit
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080099} // namespace nfd
Junxiao Shicbba04c2014-01-26 14:21:22 -0700100
101#endif // NFD_TABLE_PIT_FACE_RECORD_HPP