blob: eec0e60b62abb815071d9f4fdf67ff598d6d1e82 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014, 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_WEBSOCKET_FACTORY_HPP
#define NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP
#include "protocol-factory.hpp"
#include "websocket-channel.hpp"
namespace nfd {
class WebSocketFactory : public ProtocolFactory
{
public:
/**
* \brief Exception of WebSocketFactory
*/
class Error : public ProtocolFactory::Error
{
public:
explicit
Error(const std::string& what)
: ProtocolFactory::Error(what)
{
}
};
explicit
WebSocketFactory(const std::string& defaultPort);
/**
* \brief Create WebSocket-based channel using websocket::Endpoint
*
* websocket::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.
*
* If this method called twice with the same endpoint, only one channel
* will be created. The second call will just retrieve the existing
* channel.
*
* \returns always a valid pointer to a WebSocketChannel object, an exception
* is thrown if it cannot be created.
*
* \throws WebSocketFactory::Error, TcpResolver::Error
*
*/
shared_ptr<WebSocketChannel>
createChannel(const websocket::Endpoint& localEndpoint);
/**
* \brief Create WebSocket-based channel using specified IP address and port number
*
* This method is just a helper that converts a string representation of localIp and port to
* websocket::Endpoint and calls the other createChannel overload.
*
* \throws WebSocketFactory::Error
*/
shared_ptr<WebSocketChannel>
createChannel(const std::string& localIp, const std::string& port);
// from Factory
virtual void
createFace(const FaceUri& uri,
const FaceCreatedCallback& onCreated,
const FaceConnectFailedCallback& onConnectFailed);
virtual std::list<shared_ptr<const Channel> >
getChannels() const;
private:
/**
* \brief Look up WebSocketChannel using specified local endpoint
*
* \returns shared pointer to the existing WebSocketChannel object
* or empty shared pointer when such channel does not exist
*
* \throws never
*/
shared_ptr<WebSocketChannel>
findChannel(const websocket::Endpoint& localEndpoint);
typedef std::map< websocket::Endpoint, shared_ptr<WebSocketChannel> > ChannelMap;
ChannelMap m_channels;
std::string m_defaultPort;
};
} // namespace nfd
#endif // NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP