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>

Inheritance diagram for rpc::UnsubscribeHandler:

Collaboration diagram for rpc::UnsubscribeHandler:

Public Types
using	OrderBook = rpc::spec::handlers::unsubscribe::OrderBook
	A struct to hold one order book.
using	StreamType = rpc::spec::handlers::unsubscribe::StreamType
	A subscribable stream type.
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.

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

subscriptions

The subscription manager to use

Member Function Documentation

process()

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

nodiscard

Process the Unsubscribe command.

Parameters

input	The input data for the command
ctx	The context of the request

Returns

The result of the operation

---

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