blob: c6e07b4678e89690e2c0f398b8c386e8952f264e [file] [log] [blame]
Davide Pesavento44deacc2014-02-19 10:48:07 +01001/* -*- 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 **/
Davide Pesavento44deacc2014-02-19 10:48:07 +010024
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080025#ifndef NFD_FACE_ETHERNET_FACTORY_HPP
26#define NFD_FACE_ETHERNET_FACTORY_HPP
Davide Pesavento44deacc2014-02-19 10:48:07 +010027
28#include "ethernet-face.hpp"
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080029#include "protocol-factory.hpp"
Davide Pesavento44deacc2014-02-19 10:48:07 +010030
31namespace nfd {
32
Davide Pesaventob60cc122014-03-19 19:26:02 +010033class NetworkInterfaceInfo;
34
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080035class EthernetFactory : public ProtocolFactory
Davide Pesavento44deacc2014-02-19 10:48:07 +010036{
37public:
38 /**
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080039 * \brief Exception of EthernetFactory
Davide Pesavento44deacc2014-02-19 10:48:07 +010040 */
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080041 struct Error : public ProtocolFactory::Error
Davide Pesavento44deacc2014-02-19 10:48:07 +010042 {
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080043 Error(const std::string& what) : ProtocolFactory::Error(what) {}
Davide Pesavento44deacc2014-02-19 10:48:07 +010044 };
45
Davide Pesaventob60cc122014-03-19 19:26:02 +010046 // from ProtocolFactory
47 virtual void
48 createFace(const FaceUri& uri,
49 const FaceCreatedCallback& onCreated,
50 const FaceConnectFailedCallback& onConnectFailed);
51
Davide Pesavento44deacc2014-02-19 10:48:07 +010052 /**
53 * \brief Create an EthernetFace to communicate with the given multicast group
54 *
Davide Pesaventob60cc122014-03-19 19:26:02 +010055 * If this method is called twice with the same interface and group, only
Davide Pesavento44deacc2014-02-19 10:48:07 +010056 * one face will be created. Instead, the second call will just retrieve
57 * the existing face.
58 *
59 * \param interface Local network interface
60 * \param address Ethernet broadcast/multicast destination address
61 *
62 * \returns always a valid shared pointer to an EthernetFace object,
63 * an exception will be thrown if the creation fails
64 *
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080065 * \throws EthernetFactory::Error or EthernetFace::Error
Davide Pesavento44deacc2014-02-19 10:48:07 +010066 */
67 shared_ptr<EthernetFace>
Davide Pesaventob60cc122014-03-19 19:26:02 +010068 createMulticastFace(const shared_ptr<NetworkInterfaceInfo>& interface,
Alexander Afanasyevd6655302014-02-28 08:41:28 -080069 const ethernet::Address& address);
Davide Pesavento44deacc2014-02-19 10:48:07 +010070
Davide Pesavento44deacc2014-02-19 10:48:07 +010071private:
72 void
Davide Pesaventob60cc122014-03-19 19:26:02 +010073 afterFaceFailed(const std::string& interfaceName,
Davide Pesavento44deacc2014-02-19 10:48:07 +010074 const ethernet::Address& address);
75
76 /**
77 * \brief Look up EthernetFace using specified interface and address
78 *
79 * \returns shared pointer to the existing EthernetFace object or
80 * empty shared pointer when such face does not exist
81 *
82 * \throws never
83 */
84 shared_ptr<EthernetFace>
Davide Pesaventob60cc122014-03-19 19:26:02 +010085 findMulticastFace(const std::string& interfaceName,
Alexander Afanasyevd6655302014-02-28 08:41:28 -080086 const ethernet::Address& address) const;
Davide Pesavento44deacc2014-02-19 10:48:07 +010087
88private:
Davide Pesaventob60cc122014-03-19 19:26:02 +010089 typedef std::map< std::pair<std::string, ethernet::Address>,
Davide Pesavento44deacc2014-02-19 10:48:07 +010090 shared_ptr<EthernetFace> > MulticastFacesMap;
91 MulticastFacesMap m_multicastFaces;
92};
93
94} // namespace nfd
95
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080096#endif // NFD_FACE_ETHERNET_FACTORY_HPP