git.sesse.net Git - casparcg/blob - protocol/util/AsyncEventServer.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG is free software: you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation, either version 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 *
  16 * You should have received a copy of the GNU General Public License
  17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "..\stdafx.h"
  23
  24 #include "AsyncEventServer.h"
  25
  26 #include <algorithm>
  27 #include <array>
  28 #include <string>
  29 #include <set>
  30 #include <memory>
  31 #include <functional>
  32
  33 #include <boost/asio.hpp>
  34 #include <boost/thread.hpp>
  35 #include <boost/lexical_cast.hpp>
  36
  37 #include <tbb\mutex.h>
  38 #include <tbb\concurrent_hash_map.h>
  39 #include <tbb\concurrent_queue.h>
  40
  41 using boost::asio::ip::tcp;
  42
  43 namespace caspar { namespace IO {
  44
  45 class connection;
  46
  47 typedef std::set<spl::shared_ptr<connection>> connection_set;
  48
  49 class connection : public spl::enable_shared_from_this<connection>
  50 {
  51         typedef tbb::concurrent_hash_map<std::wstring, std::shared_ptr<void>> lifecycle_map_type;
  52         typedef tbb::concurrent_queue<std::string>      send_queue;
  53
  54     const spl::shared_ptr<tcp::socket>                          socket_;
  55         boost::asio::io_service&                                                service_;
  56         const spl::shared_ptr<connection_set>                   connection_set_;
  57         const std::wstring                                                              name_;
  58         protocol_strategy_factory<char>::ptr                    protocol_factory_;
  59         std::shared_ptr<protocol_strategy<char>>                protocol_;
  60
  61         std::array<char, 32768>                                                 data_;
  62         lifecycle_map_type                                                              lifecycle_bound_objects_;
  63         send_queue                                                                              send_queue_;
  64         bool                                                                                    is_writing_;
  65
  66         class connection_holder : public client_connection<char>
  67         {
  68                 std::weak_ptr<connection> connection_;
  69         public:
  70                 explicit connection_holder(std::weak_ptr<connection> conn) : connection_(std::move(conn))
  71                 {}
  72
  73                 virtual void send(std::basic_string<char>&& data)
  74                 {
  75                         auto conn = connection_.lock();
  76
  77                         if (conn)
  78                                 conn->send(std::move(data));
  79                 }
  80
  81                 virtual void disconnect()
  82                 {
  83                         auto conn = connection_.lock();
  84
  85                         if (conn)
  86                                 conn->disconnect();
  87                 }
  88
  89                 virtual std::wstring print() const
  90                 {
  91                         auto conn = connection_.lock();
  92
  93                         if (conn)
  94                                 return conn->print();
  95                         else
  96                                 return L"[destroyed-connection]";
  97                 }
  98
  99                 virtual void add_lifecycle_bound_object(const std::wstring& key, const std::shared_ptr<void>& lifecycle_bound)
 100                 {
 101                         auto conn = connection_.lock();
 102
 103                         if (conn)
 104                                 return conn->add_lifecycle_bound_object(key, lifecycle_bound);
 105                 }
 106                 virtual std::shared_ptr<void> remove_lifecycle_bound_object(const std::wstring& key)
 107                 {
 108                         auto conn = connection_.lock();
 109
 110                         if (conn)
 111                                 return conn->remove_lifecycle_bound_object(key);
 112                         else
 113                                 return std::shared_ptr<void>();
 114                 }
 115         };
 116
 117 public:
 118     static spl::shared_ptr<connection> create(spl::shared_ptr<tcp::socket> socket, const protocol_strategy_factory<char>::ptr& protocol, spl::shared_ptr<connection_set> connection_set)
 119         {
 120                 spl::shared_ptr<connection> con(new connection(std::move(socket), std::move(protocol), std::move(connection_set)));
 121                 con->read_some();
 122                 return con;
 123     }
 124
 125         ~connection()
 126         {
 127                 CASPAR_LOG(info) << print() << L" connection destroyed.";
 128         }
 129
 130         std::wstring print() const
 131         {
 132                 return L"[" + name_ + L"]";
 133         }
 134
 135         virtual void send(std::string&& data)
 136         {
 137                 send_queue_.push(std::move(data));
 138                 service_.dispatch([=] { do_write(); });
 139         }
 140
 141         virtual void disconnect()
 142         {
 143                 service_.dispatch([=] { stop(); });
 144         }
 145
 146         void add_lifecycle_bound_object(const std::wstring& key, const std::shared_ptr<void>& lifecycle_bound)
 147         {
 148                 //thread-safe tbb_concurrent_hash_map
 149                 lifecycle_bound_objects_.insert(std::pair<std::wstring, std::shared_ptr<void>>(key, lifecycle_bound));
 150         }
 151         std::shared_ptr<void> remove_lifecycle_bound_object(const std::wstring& key)
 152         {
 153                 //thread-safe tbb_concurrent_hash_map
 154                 lifecycle_map_type::const_accessor acc;
 155                 if(lifecycle_bound_objects_.find(acc, key))
 156                 {
 157                         auto result = acc->second;
 158                         lifecycle_bound_objects_.erase(acc);
 159                         return result;
 160                 }
 161                 return std::shared_ptr<void>();
 162         }
 163
 164         /**************/
 165 private:
 166         void do_write() //always called from the asio-service-thread
 167         {
 168                 if(!is_writing_)
 169                 {
 170                         std::string data;
 171                         if(send_queue_.try_pop(data))
 172                         {
 173                                 write_some(std::move(data));
 174                         }
 175                 }
 176         }
 177
 178         void stop()     //always called from the asio-service-thread
 179         {
 180                 connection_set_->erase(shared_from_this());
 181                 try
 182                 {
 183                         socket_->close();
 184                 }
 185                 catch(...)
 186                 {
 187                         CASPAR_LOG_CURRENT_EXCEPTION();
 188                 }
 189
 190                 CASPAR_LOG(info) << print() << L" Disconnected.";
 191         }
 192
 193         const std::string ipv4_address() const
 194         {
 195                 return socket_->is_open() ? socket_->remote_endpoint().address().to_string() : "no-address";
 196         }
 197
 198     connection(const spl::shared_ptr<tcp::socket>& socket, const protocol_strategy_factory<char>::ptr& protocol_factory, const spl::shared_ptr<connection_set>& connection_set)
 199                 : socket_(socket)
 200                 , service_(socket->get_io_service())
 201                 , name_((socket_->is_open() ? u16(socket_->local_endpoint().address().to_string() + ":" + boost::lexical_cast<std::string>(socket_->local_endpoint().port())) : L"no-address"))
 202                 , connection_set_(connection_set)
 203                 , protocol_factory_(protocol_factory)
 204                 , is_writing_(false)
 205         {
 206                 CASPAR_LOG(info) << print() << L" Connected.";
 207     }
 208
 209         protocol_strategy<char>& protocol()     //always called from the asio-service-thread
 210         {
 211                 if (!protocol_)
 212                         protocol_ = protocol_factory_->create(spl::make_shared<connection_holder>(shared_from_this()));
 213
 214                 return *protocol_;
 215         }
 216
 217     void handle_read(const boost::system::error_code& error, size_t bytes_transferred)  //always called from the asio-service-thread
 218         {
 219                 if(!error)
 220                 {
 221                         try
 222                         {
 223                                 std::string data(data_.begin(), data_.begin() + bytes_transferred);
 224
 225                                 CASPAR_LOG(trace) << print() << L" Received: " << u16(data);
 226
 227                                 protocol().parse(data);
 228                         }
 229                         catch(...)
 230                         {
 231                                 CASPAR_LOG_CURRENT_EXCEPTION();
 232                         }
 233
 234                         read_some();
 235                 }
 236                 else if (error != boost::asio::error::operation_aborted)
 237                         stop();
 238     }
 239
 240     void handle_write(const spl::shared_ptr<std::string>& str, const boost::system::error_code& error, size_t bytes_transferred)        //always called from the asio-service-thread
 241         {
 242                 if(!error)
 243                 {
 244                         CASPAR_LOG(trace) << print() << L" Sent: " << (str->size() < 512 ? u16(*str) : L"more than 512 bytes.");
 245                         if(bytes_transferred != str->size())
 246                         {
 247                                 str->assign(str->substr(bytes_transferred));
 248                                 socket_->async_write_some(boost::asio::buffer(str->data(), str->size()), std::bind(&connection::handle_write, shared_from_this(), str, std::placeholders::_1, std::placeholders::_2));
 249                         }
 250                         else
 251                         {
 252                                 is_writing_ = false;
 253                                 do_write();
 254                         }
 255                 }
 256                 else if (error != boost::asio::error::operation_aborted)
 257                         stop();
 258     }
 259
 260         void read_some()        //always called from the asio-service-thread
 261         {
 262                 socket_->async_read_some(boost::asio::buffer(data_.data(), data_.size()), std::bind(&connection::handle_read, shared_from_this(), std::placeholders::_1, std::placeholders::_2));
 263         }
 264
 265         void write_some(std::string&& data)     //always called from the asio-service-thread
 266         {
 267                 is_writing_ = true;
 268                 auto str = spl::make_shared<std::string>(std::move(data));
 269                 socket_->async_write_some(boost::asio::buffer(str->data(), str->size()), std::bind(&connection::handle_write, shared_from_this(), str, std::placeholders::_1, std::placeholders::_2));
 270         }
 271
 272         friend struct AsyncEventServer::implementation;
 273 };
 274
 275 struct AsyncEventServer::implementation
 276 {
 277         boost::asio::io_service                                 service_;
 278         tcp::acceptor                                                   acceptor_;
 279         protocol_strategy_factory<char>::ptr    protocol_factory_;
 280         spl::shared_ptr<connection_set>                 connection_set_;
 281         boost::thread                                                   thread_;
 282         std::vector<lifecycle_factory_t>                lifecycle_factories_;
 283         tbb::mutex mutex_;
 284
 285         implementation(const protocol_strategy_factory<char>::ptr& protocol, unsigned short port)
 286                 : acceptor_(service_, tcp::endpoint(tcp::v4(), port))
 287                 , protocol_factory_(protocol)
 288                 , thread_([&] { service_.run(); })
 289         {
 290                 start_accept();
 291         }
 292
 293         ~implementation()
 294         {
 295                 try
 296                 {
 297                         acceptor_.close();
 298                 }
 299                 catch(...)
 300                 {
 301                         CASPAR_LOG_CURRENT_EXCEPTION();
 302                 }
 303
 304                 service_.post([=]
 305                 {
 306                         auto connections = *connection_set_;
 307                         for (auto& connection : connections)
 308                                 connection->stop();
 309                 });
 310
 311                 thread_.join();
 312         }
 313
 314     void start_accept()
 315         {
 316                 spl::shared_ptr<tcp::socket> socket(new tcp::socket(service_));
 317                 acceptor_.async_accept(*socket, std::bind(&implementation::handle_accept, this, socket, std::placeholders::_1));
 318     }
 319
 320         void handle_accept(const spl::shared_ptr<tcp::socket>& socket, const boost::system::error_code& error)
 321         {
 322                 if (!acceptor_.is_open())
 323                         return;
 324
 325         if (!error)
 326                 {
 327                         auto conn = connection::create(socket, protocol_factory_, connection_set_);
 328                         connection_set_->insert(conn);
 329
 330                         for (auto& lifecycle_factory : lifecycle_factories_)
 331                         {
 332                                 auto lifecycle_bound = lifecycle_factory(conn->ipv4_address());
 333                                 conn->add_lifecycle_bound_object(lifecycle_bound.first, lifecycle_bound.second);
 334                         }
 335                 }
 336                 start_accept();
 337     }
 338
 339         void add_client_lifecycle_object_factory(const lifecycle_factory_t& factory)
 340         {
 341                 service_.post([=]{ lifecycle_factories_.push_back(factory); });
 342         }
 343 };
 344
 345 AsyncEventServer::AsyncEventServer(
 346                 const protocol_strategy_factory<char>::ptr& protocol, unsigned short port)
 347         : impl_(new implementation(protocol, port)) {}
 348
 349 AsyncEventServer::~AsyncEventServer() {}
 350 void AsyncEventServer::add_client_lifecycle_object_factory(const lifecycle_factory_t& factory) { impl_->add_client_lifecycle_object_factory(factory); }
 351
 352 }}