graphene::app::network_broadcast_api Class Reference

The network_broadcast_api class allows broadcasting of transactions. More...

#include <api.hpp>

Inheritance diagram for graphene::app::network_broadcast_api:

Classes
struct	transaction_confirmation

Public Types
using	confirmation_callback = std::function< void(variant)>

Public Member Functions
	network_broadcast_api (application &a)
void	broadcast_transaction (const precomputable_transaction &trx)
	Broadcast a transaction to the network. More...
void	broadcast_transaction_with_callback (confirmation_callback cb, const precomputable_transaction &trx)
fc::variant	broadcast_transaction_synchronous (const precomputable_transaction &trx)
void	broadcast_block (const signed_block &block)
	Broadcast a signed block to the network. More...
void	on_applied_block (const signed_block &b)
	Not reflected, thus not accessible to API clients. More...

Detailed Description

The network_broadcast_api class allows broadcasting of transactions.

Definition at line 330 of file api.hpp.

Member Typedef Documentation

confirmation_callback

using graphene::app::network_broadcast_api::confirmation_callback = std::function<void(variant)>

Definition at line 343 of file api.hpp.

Constructor & Destructor Documentation

network_broadcast_api()

graphene::app::network_broadcast_api::network_broadcast_api ( application &  a )

explicit

Definition at line 132 of file api.cpp.

Member Function Documentation

broadcast_block()

void graphene::app::network_broadcast_api::broadcast_block

(

const signed_block &

block

)

Broadcast a signed block to the network.

Parameters

block

The signed block to broadcast

Definition at line 181 of file api.cpp.

broadcast_transaction()

void graphene::app::network_broadcast_api::broadcast_transaction

(

const precomputable_transaction &

trx

)

Broadcast a transaction to the network.

Parameters

trx	The transaction to broadcast

The transaction will be checked for validity in the local database prior to broadcasting. If it fails to apply locally, an error will be thrown and the transaction will not be broadcast.

Definition at line 163 of file api.cpp.

broadcast_transaction_synchronous()

fc::variant graphene::app::network_broadcast_api::broadcast_transaction_synchronous

(

const precomputable_transaction &

trx

)

This version of broadcast transaction waits until the transaction is included into a block, then the transaction id, block number, and transaction number in the block will be returned.

Parameters

trx	the transaction

Returns

info about the block including the transaction

Definition at line 171 of file api.cpp.

broadcast_transaction_with_callback()

void graphene::app::network_broadcast_api::broadcast_transaction_with_callback	(	confirmation_callback	cb,
		const precomputable_transaction &	trx
	)

This version of broadcast transaction registers a callback method that will be called when the transaction is included into a block. The callback method includes the transaction id, block number, and transaction number in the block.

Parameters

cb	the callback method
trx	the transaction

Definition at line 189 of file api.cpp.

on_applied_block()

void graphene::app::network_broadcast_api::on_applied_block

(

const signed_block &

b

)

Not reflected, thus not accessible to API clients.

This function is registered to receive the applied_block signal from the chain database when a block is received. It then dispatches callbacks to clients who have requested to be notified when a particular txid is included in a block.

we need to ensure the database_api is not deleted for the life of the async operation

Definition at line 138 of file api.cpp.

---

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

• libraries/app/include/graphene/app/api.hpp
• libraries/app/api.cpp