mirror of
https://github.com/XRPLF/rippled.git
synced 2026-07-23 15:10:34 +00:00
131 lines
3.2 KiB
C++
131 lines
3.2 KiB
C++
#pragma once
|
|
|
|
#include <xrpl/beast/net/IPEndpoint.h>
|
|
#include <xrpl/beast/utility/Journal.h>
|
|
#include <xrpl/server/Handoff.h>
|
|
#include <xrpl/server/Port.h>
|
|
#include <xrpl/server/WSSession.h>
|
|
#include <xrpl/server/Writer.h>
|
|
|
|
#include <boost/beast/http/message.hpp>
|
|
|
|
#include <cstddef>
|
|
#include <memory>
|
|
#include <string_view>
|
|
|
|
namespace xrpl {
|
|
|
|
/**
|
|
* Persistent state information for a connection session.
|
|
* These values are preserved between calls for efficiency.
|
|
* Some fields are input parameters, some are output parameters,
|
|
* and all only become defined during specific callbacks.
|
|
*/
|
|
class Session
|
|
{
|
|
public:
|
|
Session() = default;
|
|
Session(Session const&) = delete;
|
|
Session&
|
|
operator=(Session const&) = delete;
|
|
virtual ~Session() = default;
|
|
|
|
/**
|
|
* A user-definable pointer.
|
|
* The initial value is always zero.
|
|
* Changes to the value are persisted between calls.
|
|
*/
|
|
void* tag = nullptr;
|
|
|
|
/**
|
|
* Returns the Journal to use for logging.
|
|
*/
|
|
virtual beast::Journal
|
|
journal() = 0;
|
|
|
|
/**
|
|
* Returns the Port settings for this connection.
|
|
*/
|
|
virtual Port const&
|
|
port() = 0;
|
|
|
|
/**
|
|
* Returns the remote address of the connection.
|
|
*/
|
|
virtual beast::IP::Endpoint
|
|
remoteAddress() = 0;
|
|
|
|
/**
|
|
* Returns the current HTTP request.
|
|
*/
|
|
virtual http_request_type&
|
|
request() = 0;
|
|
|
|
/**
|
|
* Send a copy of data asynchronously.
|
|
*/
|
|
/** @{ */
|
|
void
|
|
write(std::string_view s)
|
|
{
|
|
if (!s.empty())
|
|
write(s.data(), s.size());
|
|
}
|
|
|
|
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(buffer.data(), 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 keepAlive) = 0;
|
|
|
|
/** @} */
|
|
|
|
/**
|
|
* Detach the session.
|
|
* This holds the session open so that the response can be sent
|
|
* asynchronously. Calls to io_context::run made by the server
|
|
* will not return until all detached sessions are closed.
|
|
*/
|
|
virtual std::shared_ptr<Session>
|
|
detach() = 0;
|
|
|
|
/**
|
|
* Indicate that the response is complete.
|
|
* The handler should call this when it has completed writing
|
|
* the response. If Keep-Alive is indicated on the connection,
|
|
* this will trigger a read for the next request; else, the
|
|
* connection will be closed when all remaining data has been sent.
|
|
*/
|
|
virtual void
|
|
complete() = 0;
|
|
|
|
/**
|
|
* Close the session.
|
|
* This will be performed asynchronously. The session will be
|
|
* closed gracefully after all pending writes have completed.
|
|
* @param graceful `true` to wait until all data has finished sending.
|
|
*/
|
|
virtual void
|
|
close(bool graceful) = 0;
|
|
|
|
/**
|
|
* Convert the connection to WebSocket.
|
|
*/
|
|
virtual std::shared_ptr<WSSession>
|
|
websocketUpgrade() = 0;
|
|
};
|
|
|
|
} // namespace xrpl
|