Session.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_SERVER_SESSION_H_INCLUDED
#define RIPPLE_SERVER_SESSION_H_INCLUDED
 
#include <xrpl/beast/net/IPEndpoint.h>
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/server/WSSession.h>
#include <xrpl/server/Writer.h>
 
#include <boost/beast/http/message.hpp>
 
#include <functional>
#include <memory>
#include <ostream>
#include <vector>
 
namespace ripple {
 
class Session
{
public:
    Session() = default;
    Session(Session const&) = delete;
    Session&
    operator=(Session const&) = delete;
    virtual ~Session() = default;
 
    void* tag = nullptr;
 
    virtual beast::Journal
    journal() = 0;
 
    virtual Port const&
    port() = 0;
 
    virtual beast::IP::Endpoint
    remoteAddress() = 0;
 
    virtual http_request_type&
    request() = 0;
 
    void
    write(std::string const& s)
    {
        if (!s.empty())
            write(&s[0], std::distance(s.begin(), s.end()));
    }
 
    template <typename BufferSequence>
    void
    write(BufferSequence const& buffers)
    {
        for (typename BufferSequence::const_iterator iter(buffers.begin());
             iter != buffers.end();
             ++iter)
        {
            typename BufferSequence::value_type const& buffer(*iter);
            write(
                boost::asio::buffer_cast<void const*>(buffer),
                boost::asio::buffer_size(buffer));
        }
    }
 
    virtual void
    write(void const* buffer, std::size_t bytes) = 0;
 
    virtual void
    write(std::shared_ptr<Writer> const& writer, bool keep_alive) = 0;
 
    virtual std::shared_ptr<Session>
    detach() = 0;
 
    virtual void
    complete() = 0;
 
    virtual void
    close(bool graceful) = 0;
 
    virtual std::shared_ptr<WSSession>
    websocketUpgrade() = 0;
};
 
}  // namespace ripple
 
#endif