NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
unicast-ethernet-transport.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2017, 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  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
27 
28 #include <stdio.h> // for snprintf()
29 
30 namespace nfd {
31 namespace face {
32 
33 NFD_LOG_INIT("UnicastEthernetTransport");
34 
36  const ethernet::Address& remoteEndpoint,
37  ndn::nfd::FacePersistency persistency,
38  time::nanoseconds idleTimeout)
39  : EthernetTransport(localEndpoint, remoteEndpoint)
40  , m_idleTimeout(idleTimeout)
41 {
45  this->setPersistency(persistency);
47  this->setMtu(localEndpoint.getMtu());
48 
49  NFD_LOG_FACE_INFO("Creating transport");
50 
51  char filter[110];
52  // note #1: we cannot use std::snprintf because it's not available
53  // on some platforms (see #2299)
54  // note #2: "not vlan" must appear last in the filter expression, or the
55  // rest of the filter won't work as intended (see pcap-filter(7))
56  snprintf(filter, sizeof(filter),
57  "(ether proto 0x%x) && (ether src %s) && (ether dst %s) && (not vlan)",
59  m_destAddress.toString().data(),
60  m_srcAddress.toString().data());
61  m_pcap.setPacketFilter(filter);
62 
64  m_idleTimeout > time::nanoseconds::zero()) {
65  scheduleClosureWhenIdle();
66  }
67 }
68 
69 bool
71 {
72  return true;
73 }
74 
75 void
77 {
79  m_idleTimeout > time::nanoseconds::zero()) {
80  scheduleClosureWhenIdle();
81  }
82  else {
83  m_closeIfIdleEvent.cancel();
84  setExpirationTime(time::steady_clock::TimePoint::max());
85  }
86 }
87 
88 void
89 UnicastEthernetTransport::scheduleClosureWhenIdle()
90 {
91  m_closeIfIdleEvent = scheduler::schedule(m_idleTimeout, [this] {
92  if (!hasRecentlyReceived()) {
93  NFD_LOG_FACE_INFO("Closing due to inactivity");
94  this->close();
95  }
96  else {
98  scheduleClosureWhenIdle();
99  }
100  });
101  setExpirationTime(time::steady_clock::now() + m_idleTimeout);
102 }
103 
104 } // namespace face
105 } // namespace nfd
void setPersistency(ndn::nfd::FacePersistency newPersistency)
changes face persistency setting
Definition: transport.cpp:151
void cancel()
cancels the event manually
Definition: scheduler.cpp:95
void setExpirationTime(const time::steady_clock::TimePoint &expirationTime)
Definition: transport.hpp:457
void setPacketFilter(const char *filter) const
Install a BPF filter on the receiving socket.
uint32_t getMtu() const
Returns the MTU (maximum transmission unit) of the interface.
void setRemoteUri(const FaceUri &uri)
Definition: transport.hpp:396
static time_point now() noexcept
Definition: time.cpp:80
void close()
request the transport to be closed
Definition: transport.cpp:84
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
invoked after the persistency has been changed
void setLinkType(ndn::nfd::LinkType linkType)
Definition: transport.hpp:426
void setMtu(ssize_t mtu)
Definition: transport.hpp:438
void setScope(ndn::nfd::FaceScope scope)
Definition: transport.hpp:408
Represents one network interface attached to the host.
#define NFD_LOG_FACE_INFO(msg)
Log a message at INFO level.
Definition: face-log.hpp:85
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
invoked by canChangePersistencyTo to perform the check
UnicastEthernetTransport(const ndn::net::NetworkInterface &localEndpoint, const ethernet::Address &remoteEndpoint, ndn::nfd::FacePersistency persistency, time::nanoseconds idleTimeout)
Creates an Ethernet-based transport for unicast communication.
void setLocalUri(const FaceUri &uri)
Definition: transport.hpp:384
std::string toString(char sep= ':') const
Converts the address to a human-readable string.
Definition: ethernet.cpp:77
const uint16_t ETHERTYPE_NDN
Definition: ethernet.hpp:39
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:43
represents an Ethernet hardware address
Definition: ethernet.hpp:52
EventId schedule(time::nanoseconds after, const EventCallback &event)
schedule an event
Definition: scheduler.cpp:47
Base class for Ethernet-based Transports.
#define NFD_LOG_INIT(name)
Definition: logger.hpp:34
static FaceUri fromDev(const std::string &ifname)
create dev FaceUri from network device name
Definition: face-uri.cpp:171
ndn::nfd::FacePersistency getPersistency() const
Definition: transport.hpp:414