kagome::api::ApiService Class Reference

#include <api_service.hpp>

Inheritance diagram for kagome::api::ApiService:

Collaboration diagram for kagome::api::ApiService:

Public Types
using	PubsubSubscriptionId = uint32_t
	subscription id for pubsub API methods More...
template<class T >
using	sptr = std::shared_ptr< T >

Public Member Functions
virtual	~ApiService ()=default
virtual bool	prepare ()=0
virtual bool	start ()=0
virtual void	stop ()=0
virtual outcome::result< uint32_t >	subscribeSessionToKeys (const std::vector< common::Buffer > &keys)=0
virtual outcome::result< bool >	unsubscribeSessionFromIds (const std::vector< PubsubSubscriptionId > &subscription_id)=0
virtual outcome::result< PubsubSubscriptionId >	subscribeFinalizedHeads ()=0
virtual outcome::result< bool >	unsubscribeFinalizedHeads (PubsubSubscriptionId subscription_id)=0
virtual outcome::result< PubsubSubscriptionId >	subscribeNewHeads ()=0
virtual outcome::result< bool >	unsubscribeNewHeads (PubsubSubscriptionId subscription_id)=0
virtual outcome::result< PubsubSubscriptionId >	subscribeRuntimeVersion ()=0
virtual outcome::result< bool >	unsubscribeRuntimeVersion (PubsubSubscriptionId subscription_id)=0
virtual outcome::result< PubsubSubscriptionId >	subscribeForExtrinsicLifecycle (const primitives::Transaction::Hash &tx_hash)=0
virtual outcome::result< bool >	unsubscribeFromExtrinsicLifecycle (PubsubSubscriptionId subscription_id)=0

Detailed Description

Service listening for incoming JSON RPC request

Definition at line 20 of file api_service.hpp.

Member Typedef Documentation

using kagome::api::ApiService::PubsubSubscriptionId = uint32_t

subscription id for pubsub API methods

Definition at line 23 of file api_service.hpp.

template<class T >

using kagome::api::ApiService::sptr = std::shared_ptr<T>

Definition at line 26 of file api_service.hpp.

Constructor & Destructor Documentation

virtual kagome::api::ApiService::~ApiService ( )

virtualdefault

Member Function Documentation

virtual bool kagome::api::ApiService::prepare ( )

pure virtual

See also

AppStateManager::takeControl

Implemented in kagome::api::ApiServiceImpl.

virtual bool kagome::api::ApiService::start ( )

pure virtual

See also

AppStateManager::takeControl

Implemented in kagome::api::ApiServiceImpl.

virtual void kagome::api::ApiService::stop ( )

pure virtual

See also

AppStateManager::takeControl

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<PubsubSubscriptionId> kagome::api::ApiService::subscribeFinalizedHeads ( )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<PubsubSubscriptionId> kagome::api::ApiService::subscribeForExtrinsicLifecycle ( const primitives::Transaction::Hash &  tx_hash )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<PubsubSubscriptionId> kagome::api::ApiService::subscribeNewHeads ( )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<PubsubSubscriptionId> kagome::api::ApiService::subscribeRuntimeVersion ( )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<uint32_t> kagome::api::ApiService::subscribeSessionToKeys ( const std::vector< common::Buffer > &  keys )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<bool> kagome::api::ApiService::unsubscribeFinalizedHeads ( PubsubSubscriptionId  subscription_id )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<bool> kagome::api::ApiService::unsubscribeFromExtrinsicLifecycle ( PubsubSubscriptionId  subscription_id )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<bool> kagome::api::ApiService::unsubscribeNewHeads ( PubsubSubscriptionId  subscription_id )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<bool> kagome::api::ApiService::unsubscribeRuntimeVersion ( PubsubSubscriptionId  subscription_id )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

virtual outcome::result<bool> kagome::api::ApiService::unsubscribeSessionFromIds ( const std::vector< PubsubSubscriptionId > &  subscription_id )

pure virtual

Implemented in kagome::api::ApiServiceImpl.

---

The documentation for this class was generated from the following file:

• core/api/service/api_service.hpp