wamp_transport.hpp

//
// Copyright (c) Crossbar.io Technologies GmbH and contributors
//
// Boost Software License - Version 1.0 - August 17th, 2003
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

#ifndef AUTOBAHN_WAMP_TRANSPORT_HPP
#define AUTOBAHN_WAMP_TRANSPORT_HPP

#include "boost_config.hpp"

#include <memory>
#include <string>

namespace autobahn {

class wamp_message;
class wamp_transport_handler;

class wamp_transport
{
public:
    using pause_handler = std::function<void()>;

    using resume_handler = std::function<void()>;

public:
    virtual ~wamp_transport() = default;

    /*
     * CONNECTION INTERFACE
     */
    virtual boost::future<void> connect() = 0;

    virtual boost::future<void> disconnect() = 0;

    virtual bool is_connected() const = 0;

    /*
     * SENDER INTERFACE
     */
    virtual void send_message(wamp_message&& message) = 0;

    virtual void set_pause_handler(pause_handler&& handler) = 0;

    virtual void set_resume_handler(resume_handler&& handler) = 0;

    /*
     * RECEIVER INTERFACE
     */
    virtual void pause() = 0;

    virtual void resume() = 0;

    virtual void attach(
            const std::shared_ptr<wamp_transport_handler>& handler) = 0;

    virtual void detach() = 0;

    virtual bool has_handler() const = 0;
};

} // namespace autobahn

#endif // AUTOBAHN_WAMP_TRANSPORT_HPP