ccf::NodeState Class Reference

#include <node_state.h>

Inherits ccf::AbstractNodeState.

Public Member Functions
	NodeState (ringbuffer::AbstractWriterFactory &writer_factory, NetworkState &network, std::shared_ptr< RPCSessions > rpcsessions, ccf::crypto::CurveID curve_id_)
QuoteVerificationResult	verify_quote (ccf::kv::ReadOnlyTx &tx, const QuoteInfo &quote_info_, const std::vector< uint8_t > &expected_node_public_key_der, pal::PlatformAttestationMeasurement &measurement) override
void	initialize (const ccf::consensus::Configuration &consensus_config_, std::shared_ptr< RPCMap > rpc_map_, std::shared_ptr< AbstractRPCResponder > rpc_sessions_, std::shared_ptr< indexing::Indexer > indexer_, size_t sig_tx_interval_, size_t sig_ms_interval_)
void	launch_node ()
void	initiate_quote_generation ()
NodeCreateInfo	create (StartType start_type_, const ccf::StartupConfig &config_, std::vector< uint8_t > &&startup_snapshot_)
void	initiate_join_unsafe ()
void	initiate_join ()
void	start_join_timer ()
void	auto_refresh_jwt_keys ()
size_t	get_jwt_attempts () override
void	start_ledger_recovery_unsafe ()
void	recover_public_ledger_entries (const std::vector< uint8_t > &entries)
void	advance_part_of_public_network ()
void	advance_part_of_network ()
void	recover_public_ledger_end_unsafe ()
void	recover_private_ledger_entries (const std::vector< uint8_t > &entries)
void	recover_private_ledger_end_unsafe ()
void	setup_one_off_secret_hook ()
void	recover_ledger_end ()
void	setup_private_recovery_store ()
void	trigger_recovery_shares_refresh (ccf::kv::Tx &tx) override
void	trigger_ledger_chunk (ccf::kv::Tx &tx) override
void	trigger_snapshot (ccf::kv::Tx &tx) override
void	trigger_acme_refresh (ccf::kv::Tx &tx, const std::optional< std::vector< std::string > > &interfaces=std::nullopt) override
void	trigger_host_process_launch (const std::vector< std::string > &args, const std::vector< uint8_t > &input) override
void	transition_service_to_open (ccf::kv::Tx &tx, AbstractGovernanceEffects::ServiceIdentities identities) override
void	initiate_private_recovery_unsafe (ccf::kv::Tx &tx, const std::optional< LedgerSecretPtr > &unsealed_ledger_secret=std::nullopt)
void	initiate_private_recovery (ccf::kv::Tx &tx, const std::optional< LedgerSecretPtr > &unsealed_ledger_secret=std::nullopt) override
void	tick (std::chrono::milliseconds elapsed)
void	tick_end ()
void	stop_notice () override
bool	has_received_stop_notice () override
void	recv_node_inbound (const uint8_t *data, size_t size)
bool	is_primary () const override
bool	can_replicate () override
bool	is_in_initialised_state () const override
bool	is_part_of_network () const override
bool	is_reading_public_ledger () const override
bool	is_reading_private_ledger () const override
bool	is_part_of_public_network () const override
bool	is_accessible_to_members () const override
ExtendedState	state () override
bool	rekey_ledger (ccf::kv::Tx &tx) override
NodeId	get_node_id () const
ccf::kv::Version	get_startup_snapshot_seqno () override
SessionMetrics	get_session_metrics () override
ccf::crypto::Pem	get_self_signed_certificate () override
const ccf::COSESignaturesConfig &	get_cose_signatures_config () override
void	set_n2n_message_limit (size_t message_limit)
void	set_n2n_idle_timeout (std::chrono::milliseconds idle_timeout)
virtual const ccf::StartupConfig &	get_node_config () const override
virtual ccf::crypto::Pem	get_network_cert () override
virtual void	install_custom_acme_challenge_handler (const ccf::NodeInfoNetwork::RpcInterfaceID &interface_id, std::shared_ptr< ACMEChallengeHandler > h) override
virtual void	make_http_request (const ::http::URL &url, ::http::Request &&req, std::function< bool(ccf::http_status status, http::HeaderMap &&, std::vector< uint8_t > &&)> callback, const std::vector< std::string > &ca_certs={}, const std::string &app_protocol="HTTP1", bool authenticate_as_node_client_certificate=false) override
void	write_snapshot (std::span< uint8_t > snapshot_buf, size_t request_id)
virtual std::shared_ptr< ccf::kv::Store >	get_store () override
virtual ringbuffer::AbstractWriterFactory &	get_writer_factory () override
Public Member Functions inherited from ccf::AbstractNodeState
virtual	~AbstractNodeState ()
virtual void	make_http_request (const ::http::URL &url, ::http::Request &&req, std::function< bool(ccf::http_status status, ccf::http::HeaderMap &&, std::vector< uint8_t > &&)> callback, const std::vector< std::string > &ca_certs={}, const std::string &app_protocol="HTTP1", bool use_node_client_certificate=false)=0

Constructor & Destructor Documentation

NodeState()

ccf::NodeState::NodeState ( ringbuffer::AbstractWriterFactory &  writer_factory, NetworkState &  network, std::shared_ptr< RPCSessions >  rpcsessions, ccf::crypto::CurveID  curve_id_  )

inline

Member Function Documentation

advance_part_of_network()

void ccf::NodeState::advance_part_of_network ( )

inline

advance_part_of_public_network()

void ccf::NodeState::advance_part_of_public_network ( )

inline

auto_refresh_jwt_keys()

void ccf::NodeState::auto_refresh_jwt_keys ( )

inline

can_replicate()

bool ccf::NodeState::can_replicate ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

create()

NodeCreateInfo ccf::NodeState::create ( StartType  start_type_, const ccf::StartupConfig &  config_, std::vector< uint8_t > &&  startup_snapshot_  )

inline

get_cose_signatures_config()

const ccf::COSESignaturesConfig & ccf::NodeState::get_cose_signatures_config ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_jwt_attempts()

size_t ccf::NodeState::get_jwt_attempts ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_network_cert()

virtual ccf::crypto::Pem ccf::NodeState::get_network_cert ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_node_config()

virtual const ccf::StartupConfig & ccf::NodeState::get_node_config ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_node_id()

NodeId ccf::NodeState::get_node_id ( ) const

inline

get_self_signed_certificate()

ccf::crypto::Pem ccf::NodeState::get_self_signed_certificate ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_session_metrics()

SessionMetrics ccf::NodeState::get_session_metrics ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_startup_snapshot_seqno()

ccf::kv::Version ccf::NodeState::get_startup_snapshot_seqno ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_store()

virtual std::shared_ptr< ccf::kv::Store > ccf::NodeState::get_store ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

get_writer_factory()

virtual ringbuffer::AbstractWriterFactory & ccf::NodeState::get_writer_factory ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

has_received_stop_notice()

bool ccf::NodeState::has_received_stop_notice ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

initialize()

void ccf::NodeState::initialize ( const ccf::consensus::Configuration &  consensus_config_, std::shared_ptr< RPCMap >  rpc_map_, std::shared_ptr< AbstractRPCResponder >  rpc_sessions_, std::shared_ptr< indexing::Indexer >  indexer_, size_t  sig_tx_interval_, size_t  sig_ms_interval_  )

inline

initiate_join()

void ccf::NodeState::initiate_join ( )

inline

initiate_join_unsafe()

void ccf::NodeState::initiate_join_unsafe ( )

inline

initiate_private_recovery()

void ccf::NodeState::initiate_private_recovery ( ccf::kv::Tx &  tx, const std::optional< LedgerSecretPtr > &  unsealed_ledger_secret = std::nullopt  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

initiate_private_recovery_unsafe()

void ccf::NodeState::initiate_private_recovery_unsafe ( ccf::kv::Tx &  tx, const std::optional< LedgerSecretPtr > &  unsealed_ledger_secret = std::nullopt  )

inline

initiate_quote_generation()

void ccf::NodeState::initiate_quote_generation ( )

inline

install_custom_acme_challenge_handler()

virtual void ccf::NodeState::install_custom_acme_challenge_handler ( const ccf::NodeInfoNetwork::RpcInterfaceID &  interface_id, std::shared_ptr< ACMEChallengeHandler >  h  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_accessible_to_members()

bool ccf::NodeState::is_accessible_to_members ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_in_initialised_state()

bool ccf::NodeState::is_in_initialised_state ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_part_of_network()

bool ccf::NodeState::is_part_of_network ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_part_of_public_network()

bool ccf::NodeState::is_part_of_public_network ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_primary()

bool ccf::NodeState::is_primary ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_reading_private_ledger()

bool ccf::NodeState::is_reading_private_ledger ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

is_reading_public_ledger()

bool ccf::NodeState::is_reading_public_ledger ( ) const

inlineoverridevirtual

Implements ccf::AbstractNodeState.

launch_node()

void ccf::NodeState::launch_node ( )

inline

make_http_request()

virtual void ccf::NodeState::make_http_request ( const ::http::URL &  url, ::http::Request &&  req, std::function< bool(ccf::http_status status, http::HeaderMap &&, std::vector< uint8_t > &&)>  callback, const std::vector< std::string > &  ca_certs = {}, const std::string &  app_protocol = "HTTP1", bool  authenticate_as_node_client_certificate = false  )

inlineoverridevirtual

recover_ledger_end()

void ccf::NodeState::recover_ledger_end ( )

inline

recover_private_ledger_end_unsafe()

void ccf::NodeState::recover_private_ledger_end_unsafe ( )

inline

recover_private_ledger_entries()

void ccf::NodeState::recover_private_ledger_entries ( const std::vector< uint8_t > &  entries )

inline

recover_public_ledger_end_unsafe()

void ccf::NodeState::recover_public_ledger_end_unsafe ( )

inline

recover_public_ledger_entries()

void ccf::NodeState::recover_public_ledger_entries ( const std::vector< uint8_t > &  entries )

inline

recv_node_inbound()

void ccf::NodeState::recv_node_inbound ( const uint8_t *  data, size_t  size  )

inline

rekey_ledger()

bool ccf::NodeState::rekey_ledger ( ccf::kv::Tx &  tx )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

set_n2n_idle_timeout()

void ccf::NodeState::set_n2n_idle_timeout ( std::chrono::milliseconds  idle_timeout )

inline

set_n2n_message_limit()

void ccf::NodeState::set_n2n_message_limit ( size_t  message_limit )

inline

setup_one_off_secret_hook()

void ccf::NodeState::setup_one_off_secret_hook ( )

inline

setup_private_recovery_store()

void ccf::NodeState::setup_private_recovery_store ( )

inline

start_join_timer()

void ccf::NodeState::start_join_timer ( )

inline

start_ledger_recovery_unsafe()

void ccf::NodeState::start_ledger_recovery_unsafe ( )

inline

state()

ExtendedState ccf::NodeState::state ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

stop_notice()

void ccf::NodeState::stop_notice ( )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

tick()

void ccf::NodeState::tick ( std::chrono::milliseconds  elapsed )

inline

tick_end()

void ccf::NodeState::tick_end ( )

inline

transition_service_to_open()

void ccf::NodeState::transition_service_to_open ( ccf::kv::Tx &  tx, AbstractGovernanceEffects::ServiceIdentities  identities  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

trigger_acme_refresh()

void ccf::NodeState::trigger_acme_refresh ( ccf::kv::Tx &  tx, const std::optional< std::vector< std::string > > &  interfaces = std::nullopt  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

trigger_host_process_launch()

void ccf::NodeState::trigger_host_process_launch ( const std::vector< std::string > &  args, const std::vector< uint8_t > &  input  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

trigger_ledger_chunk()

void ccf::NodeState::trigger_ledger_chunk ( ccf::kv::Tx &  tx )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

trigger_recovery_shares_refresh()

void ccf::NodeState::trigger_recovery_shares_refresh ( ccf::kv::Tx &  tx )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

trigger_snapshot()

void ccf::NodeState::trigger_snapshot ( ccf::kv::Tx &  tx )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

verify_quote()

QuoteVerificationResult ccf::NodeState::verify_quote ( ccf::kv::ReadOnlyTx &  tx, const QuoteInfo &  quote_info_, const std::vector< uint8_t > &  expected_node_public_key_der, pal::PlatformAttestationMeasurement &  measurement  )

inlineoverridevirtual

Implements ccf::AbstractNodeState.

write_snapshot()

void ccf::NodeState::write_snapshot ( std::span< uint8_t >  snapshot_buf, size_t  request_id  )

inline

---

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

• src/node/node_state.h