Struct ControlServerClient 

pub struct ControlServerClient<Stub = Channel<ControlServerRequest, ControlServerResponse>>(/* private fields */);

The client stub that makes RPC calls to the server. All request methods return Futures.

Implementations

impl ControlServerClient

pub fn new<T>( config: Config, transport: T, ) -> NewClient<Self, RequestDispatch<ControlServerRequest, ControlServerResponse, T>>

where T: Transport<ClientMessage<ControlServerRequest>, Response<ControlServerResponse>>,

Returns a new client stub that sends requests over the given transport.

impl<Stub> ControlServerClient<Stub>

where Stub: Stub<Req = ControlServerRequest, Resp = ControlServerResponse>,

pub fn ping( &self, ctx: Context, ) -> impl Future<Output = Result<u64, RpcError>> + '_

Ping a node. Returns node timestamp in milliseconds.

pub fn get_status( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<NodeStatusResponse>, RpcError>> + '_

Get node status.

pub fn trigger_archives_gc( &self, ctx: Context, req: TriggerGcRequest, ) -> impl Future<Output = Result<(), RpcError>> + '_

Trigger manual GC for archives.

pub fn trigger_blocks_gc( &self, ctx: Context, req: TriggerGcRequest, ) -> impl Future<Output = Result<(), RpcError>> + '_

Trigger manual GC for blocks.

pub fn trigger_states_gc( &self, ctx: Context, req: TriggerGcRequest, ) -> impl Future<Output = Result<(), RpcError>> + '_

Trigger manual GC for states.

pub fn trigger_compaction( &self, ctx: Context, req: TriggerCompactionRequest, ) -> impl Future<Output = Result<(), RpcError>> + '_

Trigger manual compaction.

pub fn set_memory_profiler_enabled( &self, ctx: Context, enabled: bool, ) -> impl Future<Output = Result<bool, RpcError>> + '_

Sets memory profiler state. Returns whether the state was changed.

pub fn dump_memory_profiler( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<Vec<u8>>, RpcError>> + '_

Returns memory profiler dump.

pub fn get_neighbours_info( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<NeighboursInfoResponse>, RpcError>> + '_

Get node neighbours info

pub fn broadcast_external_message( &self, ctx: Context, req: BroadcastExtMsgRequest, ) -> impl Future<Output = Result<ServerResult<()>, RpcError>> + '_

Broadcast a message to validators.

pub fn get_account_state( &self, ctx: Context, req: AccountStateRequest, ) -> impl Future<Output = Result<ServerResult<AccountStateResponse>, RpcError>> + '_

Get account state.

pub fn get_blockchain_config( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<BlockchainConfigResponse>, RpcError>> + '_

Get blockchain config.

pub fn get_block( &self, ctx: Context, req: BlockRequest, ) -> impl Future<Output = Result<ServerResult<BlockResponse>, RpcError>> + '_

Get block bytes

pub fn get_block_proof( &self, ctx: Context, req: BlockRequest, ) -> impl Future<Output = Result<ServerResult<BlockResponse>, RpcError>> + '_

Get proof bytes.

pub fn get_queue_diff( &self, ctx: Context, req: BlockRequest, ) -> impl Future<Output = Result<ServerResult<BlockResponse>, RpcError>> + '_

Get queue bytes.

pub fn get_archive_info( &self, ctx: Context, req: ArchiveInfoRequest, ) -> impl Future<Output = Result<ServerResult<ArchiveInfoResponse>, RpcError>> + '_

Get archive id

pub fn get_archive_chunk( &self, ctx: Context, req: ArchiveSliceRequest, ) -> impl Future<Output = Result<ServerResult<ArchiveSliceResponse>, RpcError>> + '_

Download archive slice.

pub fn get_archive_ids( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<Vec<ArchiveInfo>>, RpcError>> + '_

Returns list of all archive ids.

pub fn get_block_ids( &self, ctx: Context, req: BlockListRequest, ) -> impl Future<Output = Result<ServerResult<BlockListResponse>, RpcError>> + '_

Returns list of all block ids.

pub fn get_overlay_ids( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<OverlayIdsResponse>, RpcError>> + '_

Returns list of all overlays.

pub fn get_overlay_peers( &self, ctx: Context, req: OverlayPeersRequest, ) -> impl Future<Output = Result<ServerResult<OverlayPeersResponse>, RpcError>> + '_

Get overlay peers.

pub fn dht_find_node( &self, ctx: Context, req: DhtFindNodeRequest, ) -> impl Future<Output = Result<ServerResult<DhtFindNodeResponse>, RpcError>> + '_

Search for k closest nodes known to peer_id that store key.

pub fn sign_elections_payload( &self, ctx: Context, req: ElectionsPayloadRequest, ) -> impl Future<Output = Result<ServerResult<ElectionsPayloadResponse>, RpcError>> + '_

Signs an elections payload.

pub fn mempool_dump_bans( &self, ctx: Context, ) -> impl Future<Output = Result<ServerResult<Vec<DumpBansItem>>, RpcError>> + '_

Dumps the current in-memory moderator ban state.

pub fn mempool_dump_events( &self, ctx: Context, req: DumpEventsRequest, ) -> impl Future<Output = Result<ServerResult<String>, RpcError>> + '_

Dumps the in-memory moderator event/toleration cache, not persisted journal rows.

pub fn mempool_ban( &self, ctx: Context, req: BanRequest, ) -> impl Future<Output = Result<ServerResult<String>, RpcError>> + '_

Queues a manual ban and waits for persisted completion while the client stays connected. After the node accepts the request, it cannot be cancelled (by timeout, disconnect, etc.).

pub fn mempool_unban( &self, ctx: Context, peer_id: HashBytes, ) -> impl Future<Output = Result<ServerResult<()>, RpcError>> + '_

Queues a manual unban and waits for persisted completion while the client stays connected. Live visibility can lag because the peer must resolve again after unban. After the node accepts the request, it cannot be cancelled (by timeout, disconnect, etc.).

pub fn mempool_list_events( &self, ctx: Context, req: ListEventsRequest, ) -> impl Future<Output = Result<ServerResult<Vec<MempoolEventDisplay>>, RpcError>> + '_

Lists persisted moderator journal records of all types. Point key with stored=true can be used to retrieve full point with a separate call.

pub fn mempool_delete_events( &self, ctx: Context, millis: Range<u64>, ) -> impl Future<Output = Result<ServerResult<()>, RpcError>> + '_

Deletes persisted moderator journal data only; does not mutate in-mem moderator state. After the node accepts the request, it cannot be cancelled (by timeout, disconnect, etc.).

pub fn mempool_get_event_point( &self, ctx: Context, key: PointKey, ) -> impl Future<Output = Result<ServerResult<Bytes>, RpcError>> + '_

Loads a point linked from a stored moderator journal record (if its key has stored flag)

Trait Implementations

impl<Stub: Clone> Clone for ControlServerClient<Stub>

fn clone(&self) -> ControlServerClient<Stub>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Stub: Debug> Debug for ControlServerClient<Stub>

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

Formats the value using the given formatter.

impl<Stub> From<Stub> for ControlServerClient<Stub>

where Stub: Stub<Req = ControlServerRequest, Resp = ControlServerResponse>,

fn from(stub: Stub) -> Self

Returns a new client stub that sends requests over the given transport.