unix-transport.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2022 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_TRANSPORT_UNIX_TRANSPORT_HPP
23 #define NDN_CXX_TRANSPORT_UNIX_TRANSPORT_HPP
24 
26 
27 #include <boost/asio/local/stream_protocol.hpp>
28 
29 namespace ndn {
30 
31 namespace detail {
32 
33 template<typename BaseTransport, typename Protocol>
34 class StreamTransportImpl;
35 
36 } // namespace detail
37 
40 class UnixTransport : public Transport
41 {
42 public:
43  explicit
44  UnixTransport(const std::string& unixSocket);
45 
46  ~UnixTransport() override;
47 
48  void
49  connect(boost::asio::io_service& ioService, ReceiveCallback receiveCallback) override;
50 
51  void
52  close() override;
53 
54  void
55  pause() override;
56 
57  void
58  resume() override;
59 
60  void
61  send(const Block& wire) override;
62 
66  static shared_ptr<UnixTransport>
67  create(const std::string& uri);
68 
70  static std::string
71  getSocketNameFromUri(const std::string& uri);
72 
73 private:
74  std::string m_unixSocket;
75 
77  friend Impl;
78  shared_ptr<Impl> m_impl;
79 };
80 
81 } // namespace ndn
82 
83 #endif // NDN_CXX_TRANSPORT_UNIX_TRANSPORT_HPP
Represents a TLV element of the NDN packet format.
Definition: block.hpp:45
Provides a "TLV-oriented" delivery service.
Definition: transport.hpp:37
std::function< void(const Block &)> ReceiveCallback
Definition: transport.hpp:54
A transport using Unix stream socket.
void resume() override
Resume the transport.
static shared_ptr< UnixTransport > create(const std::string &uri)
Create transport with parameters defined in URI.
void pause() override
Pause the transport, canceling all pending operations.
void send(const Block &wire) override
Send a TLV block through the transport.
~UnixTransport() override
void connect(boost::asio::io_service &ioService, ReceiveCallback receiveCallback) override
Asynchronously open the connection.
UnixTransport(const std::string &unixSocket)
void close() override
Close the connection.
Implementation detail of a Boost.Asio-based stream-oriented transport.
#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:48
Definition: data.cpp:25