LocalTransport.h

Go to the documentation of this file.

 
#include "RobotRaconteur/RobotRaconteurNode.h"
#include <boost/shared_array.hpp>
 
#pragma once
 
namespace RobotRaconteur
{
class ROBOTRACONTEUR_CORE_API LocalTransportConnection;
 
namespace detail
{
class LocalTransportFDs;
class LocalTransportDiscovery;
class LocalTransport_socket;
class LocalTransport_acceptor;
} // namespace detail

class ROBOTRACONTEUR_CORE_API LocalTransport : public Transport, public RR_ENABLE_SHARED_FROM_THIS<LocalTransport>
{
    friend class LocalTransportConnection;
 
  private:
    std::string socket_file_name;
 
    bool transportopen;
 
  public:
    RR_UNORDERED_MAP<uint32_t, RR_SHARED_PTR<ITransportConnection> > TransportConnections;
    boost::mutex TransportConnections_lock;

    LocalTransport(const RR_SHARED_PTR<RobotRaconteurNode>& node = RobotRaconteurNode::sp());
 
    RR_OVIRTUAL ~LocalTransport() RR_OVERRIDE;
 
    RR_OVIRTUAL bool IsServer() const RR_OVERRIDE;
 
    RR_OVIRTUAL bool IsClient() const RR_OVERRIDE;
 
    RR_OVIRTUAL std::string GetUrlSchemeString() const RR_OVERRIDE;
 
    RR_OVIRTUAL std::vector<std::string> GetServerListenUrls() RR_OVERRIDE;
 
    RR_OVIRTUAL void SendMessage(const RR_INTRUSIVE_PTR<Message>& m) RR_OVERRIDE;
 
    RR_OVIRTUAL void AsyncSendMessage(
        const RR_INTRUSIVE_PTR<Message>& m,
        const boost::function<void(const RR_SHARED_PTR<RobotRaconteurException>&)>& handler) RR_OVERRIDE;
 
    RR_OVIRTUAL void AsyncCreateTransportConnection(
        boost::string_ref url, const RR_SHARED_PTR<Endpoint>& e,
        boost::function<void(const RR_SHARED_PTR<ITransportConnection>&,
                             const RR_SHARED_PTR<RobotRaconteurException>&)>& callback) RR_OVERRIDE;
 
    RR_OVIRTUAL RR_SHARED_PTR<ITransportConnection> CreateTransportConnection(
        boost::string_ref url, const RR_SHARED_PTR<Endpoint>& e) RR_OVERRIDE;
 
    RR_OVIRTUAL void CloseTransportConnection(const RR_SHARED_PTR<Endpoint>& e) RR_OVERRIDE;
 
  protected:
    virtual void AsyncCreateTransportConnection2(
        const RR_SHARED_PTR<detail::LocalTransport_socket>& socket, const std::string& noden,
        const RR_SHARED_PTR<ITransportConnection>& transport, const RR_SHARED_PTR<RobotRaconteurException>& err,
        boost::function<void(const RR_SHARED_PTR<ITransportConnection>&,
                             const RR_SHARED_PTR<RobotRaconteurException>&)>& callback);
 
    virtual void CloseTransportConnection_timed(const boost::system::error_code& err, const RR_SHARED_PTR<Endpoint>& e,
                                                const RR_SHARED_PTR<void>& timer);
 
  public:
    static bool IsLocalTransportSupported();

    virtual void StartClientAsNodeName(boost::string_ref name);

    virtual void StartServerAsNodeName(boost::string_ref name, bool public_ = false);

    virtual void StartServerAsNodeID(const NodeID& nodeid, bool public_ = false);
 
    RR_OVIRTUAL bool CanConnectService(boost::string_ref url) RR_OVERRIDE;
 
    RR_OVIRTUAL void Close() RR_OVERRIDE;
 
    RR_OVIRTUAL void CheckConnection(uint32_t endpoint) RR_OVERRIDE;
 
    RR_OVIRTUAL void PeriodicCleanupTask() RR_OVERRIDE;
 
    RR_OVIRTUAL uint32_t TransportCapability(boost::string_ref name) RR_OVERRIDE;
 
    RR_OVIRTUAL void MessageReceived(const RR_INTRUSIVE_PTR<Message>& m) RR_OVERRIDE;
 
    RR_OVIRTUAL void AsyncGetDetectedNodes(
        const std::vector<std::string>& schemes,
        const boost::function<void(const RR_SHARED_PTR<std::vector<NodeDiscoveryInfo> >&)>& handler,
        int32_t timeout = RR_TIMEOUT_INFINITE) RR_OVERRIDE;

    virtual int32_t GetMaxMessageSize();
    virtual void SetMaxMessageSize(int32_t size);

    virtual bool GetDisableMessage4();
    virtual void SetDisableMessage4(bool d);

    virtual bool GetDisableStringTable();
    virtual void SetDisableStringTable(bool d);

    virtual bool GetDisableAsyncMessageIO();
    virtual void SetDisableAsyncMessageIO(bool d);

    virtual void EnableNodeDiscoveryListening();

    virtual void DisableNodeDiscoveryListening();
 
    template <typename T, typename F>
    boost::signals2::connection AddCloseListener(const RR_SHARED_PTR<T>& t, const F& f)
    {
        boost::mutex::scoped_lock lock(closed_lock);
        if (closed)
        {
            lock.unlock();
            boost::bind(f, t)();
            return boost::signals2::connection();
        }
 
        return close_signal.connect(boost::signals2::signal<void()>::slot_type(boost::bind(f, t.get())).track(t));
    }
 
  protected:
    RR_OVIRTUAL void LocalNodeServicesChanged() RR_OVERRIDE;
 
    RR_SHARED_PTR<detail::LocalTransport_acceptor> acceptor;
 
    boost::mutex acceptor_lock;
 
    static void handle_accept(const RR_SHARED_PTR<LocalTransport>& parent,
                              const RR_SHARED_PTR<detail::LocalTransport_acceptor>& acceptor,
                              const RR_SHARED_PTR<detail::LocalTransport_socket>& socket,
                              const boost::system::error_code& error);
 
    virtual void register_transport(const RR_SHARED_PTR<ITransportConnection>& connection);
    virtual void erase_transport(const RR_SHARED_PTR<ITransportConnection>& connection);
 
    boost::mutex fds_lock;
    RR_SHARED_PTR<detail::LocalTransportFDs> fds;
 
    boost::mutex parameter_lock;
    int32_t max_message_size;
    bool disable_message4;
    bool disable_string_table;
    bool disable_async_message_io;
 
    RR_SHARED_PTR<detail::LocalTransportDiscovery> discovery;
    boost::mutex discovery_lock;
 
    bool closed;
    boost::mutex closed_lock;
    boost::signals2::signal<void()> close_signal;
};

class ROBOTRACONTEUR_CORE_API NodeNameAlreadyInUse : public std::runtime_error
{
  public:
    NodeNameAlreadyInUse() : runtime_error("Could not start server: NodeName already in use"){};
};

class ROBOTRACONTEUR_CORE_API NodeIDAlreadyInUse : public std::runtime_error
{
  public:
    NodeIDAlreadyInUse() : runtime_error("Could not start server: NodeID already in use"){};
};
 
#ifndef ROBOTRACONTEUR_NO_CXX11_TEMPLATE_ALIASES
using LocalTransportPtr = RR_SHARED_PTR<LocalTransport>;
#endif
} // namespace RobotRaconteur