Struct zebra_rpc::server::RpcServer

pub struct RpcServer {
    config: Config,
    network: Network,
    build_version: String,
    close_handle: CloseHandle,
}

Zebra RPC Server

Fields

config: Config

The RPC config.

network: Network

The configured network.

build_version: String

Zebra’s application version, with build metadata.

close_handle: CloseHandle

A handle that shuts down the RPC server.

Implementations

impl RpcServer

pub fn spawn<VersionString, UserAgentString, Mempool, State, Tip, BlockVerifierRouter, SyncStatus, AddressBook>( config: Config, mining_config: Config, build_version: VersionString, user_agent: UserAgentString, mempool: Mempool, state: State, block_verifier_router: BlockVerifierRouter, sync_status: SyncStatus, address_book: AddressBook, latest_chain_tip: Tip, network: Network, ) -> (JoinHandle<()>, JoinHandle<()>, Option<Self>)

where VersionString: ToString + Clone + Send + 'static, UserAgentString: ToString + Clone + Send + 'static, Mempool: Service<Request, Response = Response, Error = BoxError> + Clone + Send + Sync + 'static, Mempool::Future: Send, State: Service<ReadRequest, Response = ReadResponse, Error = BoxError> + Clone + Send + Sync + 'static, State::Future: Send, Tip: ChainTip + Clone + Send + Sync + 'static, BlockVerifierRouter: Service<Request, Response = Hash, Error = BoxError> + Clone + Send + Sync + 'static, <BlockVerifierRouter as Service<Request>>::Future: Send, SyncStatus: ChainSyncStatus + Clone + Send + Sync + 'static, AddressBook: AddressBookPeers + Clone + Send + Sync + 'static,

Start a new RPC server endpoint using the supplied configs and services.

build_version and user_agent are version strings for the application, which are used in RPC responses.

Returns [JoinHandle]s for the RPC server and sendrawtransaction queue tasks, and a RpcServer handle, which can be used to shut down the RPC server task.

pub fn shutdown_blocking(&self)

Shut down this RPC server, blocking the current thread.

This method can be called from within a tokio executor without panicking. But it is blocking, so shutdown() should be used instead.

pub fn shutdown(&self) -> JoinHandle<()>

Shut down this RPC server asynchronously. Returns a task that completes when the server is shut down.

fn shutdown_blocking_inner(close_handle: CloseHandle, config: Config)

Shuts down this RPC server using its close_handle.

See shutdown_blocking() for details.

Trait Implementations

impl Clone for RpcServer

fn clone(&self) -> RpcServer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RpcServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RpcServer

fn drop(&mut self)

Executes the destructor for this type.