blob: b16b4fd1047309bc06fd192736139be4f44a3b9b [file] [log] [blame]
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -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
21#ifndef _CCNX_PIT_ENTRY_OUTGOING_FACE_H_
22#define _CCNX_PIT_ENTRY_OUTGOING_FACE_H_
23
24#include "ns3/nstime.h"
25#include "ns3/ptr.h"
26
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070027#include "ns3/ccnx-face.h"
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070028
29namespace ns3 {
30
31/**
32 * \ingroup ccnx
33 * \brief PIT state component for each outgoing interest
34 */
35struct CcnxPitEntryOutgoingFace
36{
37 Ptr<CcnxFace> m_face; ///< \brief face of the outgoing Interest
38 Time m_sendTime; ///< \brief time when the first outgoing interest is sent (for RTT measurements)
39 ///< \todo handle problem of retransmitted interests... Probably, we should include something similar
40 ///< to TimeStamp TCP option for retransmitted (i.e., only lost interests will suffer)
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080041 uint32_t m_retxCount; ///< \brief number of retransmission
Alexander Afanasyev5a595072011-11-25 14:49:07 -080042 bool m_waitingInVain; ///< \brief when flag is set, we do not expect data for this interest, only a small hope that it will happen
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070043
44public:
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070045 /**
46 * @brief Constructor to create CcnxPitEntryOutgoingFace
47 * \param face face of the outgoing interest
48 */
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070049 CcnxPitEntryOutgoingFace (Ptr<CcnxFace> face);
50
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080051 /**
52 * @brief Update outgoing entry upon retransmission
53 */
54 void
55 UpdateOnRetransmit ();
56
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070057 /**
58 * @brief Compare to CcnxPitEntryOutgoingFace
59 */
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070060 bool operator== (const CcnxPitEntryOutgoingFace &dst) { return *m_face==*dst.m_face; }
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -070061
62 /**
63 * @brief Compare CcnxPitEntryOutgoingFace with CcnxFace
64 */
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070065 bool operator== (Ptr<CcnxFace> face) { return *m_face==*face; }
66
67 /**
68 * \brief Comparison operator used by boost::multi_index::identity<>
69 */
70 bool
71 operator< (const CcnxPitEntryOutgoingFace &m) const { return *m_face < *(m.m_face); } // return identity of the face
72};
73
74
75} // namespace ns3
76
77#endif /* CCNX_PIT_ENTRY_OUTGOING_FACE_H */