blob: 80b92e69e90cd0c54d2ef2587db585bfcbc94699 [file] [log] [blame]
Alexander Afanasyeva9034b02014-01-26 18:32:02 -08001/* -*- 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 **/
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080024
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080025#ifndef NFD_FACE_PROTOCOL_FACTORY_HPP
26#define NFD_FACE_PROTOCOL_FACTORY_HPP
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080027
28#include "common.hpp"
Alexander Afanasyevd6655302014-02-28 08:41:28 -080029#include "core/face-uri.hpp"
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080030
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080031namespace nfd {
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080032
Alexander Afanasyevd6655302014-02-28 08:41:28 -080033class Face;
34
35/**
36 * \brief Prototype for the callback called when face is created
37 * (as a response to incoming connection or after connection
38 * is established)
39 */
40typedef function<void(const shared_ptr<Face>& newFace)> FaceCreatedCallback;
41
42/**
43 * \brief Prototype for the callback that is called when face is failed to
44 * get created
45 */
46typedef function<void(const std::string& reason)> FaceConnectFailedCallback;
47
48
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080049class ProtocolFactory
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080050{
51public:
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080052 /**
53 * \brief Base class for all exceptions thrown by channel factories
54 */
55 struct Error : public std::runtime_error
56 {
57 Error(const std::string& what) : std::runtime_error(what) {}
58 };
Alexander Afanasyevd6655302014-02-28 08:41:28 -080059
60 /** \brief Try to create Face using the supplied Face URI
61 *
62 * This method should automatically choose channel, based on supplied Face URI
63 * and create face.
64 *
65 * \throws Factory::Error if Factory does not support connect operation
66 */
67 virtual void
68 createFace(const FaceUri& uri,
69 const FaceCreatedCallback& onCreated,
70 const FaceConnectFailedCallback& onConnectFailed) = 0;
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080071};
72
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080073} // namespace nfd
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080074
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080075#endif // NFD_FACE_PROTOCOL_FACTORY_HPP