Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::UnsubscribeHandler Class Reference

Handles the unsubscribe command which is used to disconnect a subscriber from a feed. The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions. More...

#include <Unsubscribe.hpp>

Classes

struct  Input
 A struct to hold the input data for the command. More...
struct  OrderBook
 A struct to hold one order book. More...

Public Types

using Output = VoidOutput
using Result = HandlerReturnType<Output>

Public Member Functions

 UnsubscribeHandler (std::shared_ptr< feed::SubscriptionManagerInterface > const &subscriptions)
 Construct a new BaseUnsubscribeHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the Unsubscribe command.

Static Public Member Functions

static RpcSpecConstRef spec (uint32_t apiVersion)
 Returns the API specification for the command.

Friends

Input tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)
 Convert a JSON object to an Input.

Detailed Description

Handles the unsubscribe command which is used to disconnect a subscriber from a feed. The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions.

For more details see: https://xrpl.org/unsubscribe.html

Constructor & Destructor Documentation

◆ UnsubscribeHandler()

rpc::UnsubscribeHandler::UnsubscribeHandler ( std::shared_ptr< feed::SubscriptionManagerInterface > const & subscriptions)

Construct a new BaseUnsubscribeHandler object.

Parameters
subscriptionsThe subscription manager to use

Member Function Documentation

◆ process()

UnsubscribeHandler::Result rpc::UnsubscribeHandler::process ( Input const & input,
Context const & ctx ) const

Process the Unsubscribe command.

Parameters
inputThe input data for the command
ctxThe context of the request
Returns
The result of the operation

◆ spec()

RpcSpecConstRef rpc::UnsubscribeHandler::spec ( uint32_t apiVersion)
static

Returns the API specification for the command.

Parameters
apiVersionThe api version to return the spec for
Returns
The spec for the given apiVersion

◆ tag_invoke

Input tag_invoke ( boost::json::value_to_tag< Input > ,
boost::json::value const & jv )
friend

Convert a JSON object to an Input.

Parameters
jvThe JSON object to convert
Returns
The Input object

The documentation for this class was generated from the following files:
  • /__w/clio/clio/src/rpc/handlers/Unsubscribe.hpp
  • /__w/clio/clio/src/rpc/handlers/Unsubscribe.cpp