daemon/face/unicast-ethernet-transport.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2023,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef NFD_DAEMON_FACE_UNICAST_ETHERNET_TRANSPORT_HPP
#define NFD_DAEMON_FACE_UNICAST_ETHERNET_TRANSPORT_HPP

#include "ethernet-transport.hpp"

namespace nfd::face {

/**
 * @brief A unicast Transport that uses raw Ethernet II frames.
 */
class UnicastEthernetTransport final : public EthernetTransport
{
public:
  /**
   * @brief Creates an Ethernet-based transport for unicast communication.
   */
  UnicastEthernetTransport(const ndn::net::NetworkInterface& localEndpoint,
                           const ethernet::Address& remoteEndpoint,
                           ndn::nfd::FacePersistency persistency,
                           time::nanoseconds idleTimeout);

protected:
  bool
  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final;

  void
  afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final;

private:
  void
  scheduleClosureWhenIdle();

private:
  const time::nanoseconds m_idleTimeout;
  scheduler::ScopedEventId m_closeIfIdleEvent;
};

} // namespace nfd::face

#endif // NFD_DAEMON_FACE_UNICAST_ETHERNET_TRANSPORT_HPP