Struct swarm_nl::core::Core

pub struct Core<T: EventHandler + Clone + Send + Sync + 'static> {
    pub state: Arc<Mutex<T>>,
    /* private fields */
}

The core interface for the application layer to interface with the networking layer.

Fields

state: Arc<Mutex<T>>

The state of the application

Implementations

impl<T: EventHandler + Clone + Send + Sync + 'static> Core<T>

pub fn save_keypair_offline(&self, config_file_path: &str) -> bool

Serialize keypair to protobuf format and write to config file on disk. This could be useful for saving a keypair for future use when going offline.

It returns a boolean to indicate success of operation. Only key types other than RSA can be serialized to protobuf format and only a single keypair can be saved at a time.

pub fn peer_id(&self) -> PeerId

Return the node’s PeerId.

pub async fn send_to_network( &mut self, app_request: AppData ) -> Option<StreamId>

Send data to the network layer and recieve a unique StreamId to track the request.

If the internal stream buffer is full, None will be returned.

pub async fn recv_from_network(&mut self, stream_id: StreamId) -> NetworkResult

Explicitly retrieve the reponse to a request sent to the network layer. This function is decoupled from the Core::send_to_network() method so as to prevent blocking until the response is returned.

pub async fn query_network(&mut self, request: AppData) -> NetworkResult

Perform an atomic send and recieve to and from the network layer. This function is atomic and blocks until the result of the request is returned from the network layer.

This function should mostly be used when the result of the request is needed immediately and delay can be condoned. It will still timeout if the delay exceeds the configured period.

If the internal buffer is full, it will return an error.

Trait Implementations

impl<T: Clone + EventHandler + Clone + Send + Sync + 'static> Clone for Core<T>

fn clone(&self) -> Core<T>

Returns a copy of the value.

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

Performs copy-assignment from source.