Struct tari_comms_dht::outbound::SendMessageParams

pub struct SendMessageParams { /* fields omitted */ }

Configuration for outbound messages.

use tari_comms::types::CommsPublicKey;

// These params represent sending to 5 random peers. The message will be able to be decrypted by
// the peer with the corresponding secret key of `dest_public_key`.
let dest_public_key = CommsPublicKey::default();
let params = SendMessageParams::new()
  .random(5)
  .with_encryption(OutboundEncryption::EncryptFor(Box::new(dest_public_key)))
  .finish();

Implementations

impl SendMessageParams

pub fn new() -> Self

pub fn direct_public_key(&mut self, public_key: CommsPublicKey) -> &mut Self

Set broadcast_strategy to DirectPublicKey

pub fn direct_node_id(&mut self, node_id: NodeId) -> &mut Self

Set broadcast_strategy to DirectNodeId

pub fn closest(
    &mut self,
    node_id: NodeId,
    excluded_peers: Vec<NodeId>
) -> &mut Self

Use the Closest broadcast strategy.

Parameters

node_id - Select the closest known peers to this NodeId excluded_peers - vector of NodeIds to exclude from broadcast.

pub fn closest_connected(
    &mut self,
    node_id: NodeId,
    excluded_peers: Vec<NodeId>
) -> &mut Self

Set broadcast_strategy to Closest.excluded_peers are excluded. Only peers that are currently connected will be included.

pub fn broadcast(&mut self, excluded_peers: Vec<NodeId>) -> &mut Self

Set broadcast_strategy to Neighbours. excluded_peers are excluded. Only Peers that have PeerFeatures::MESSAGE_PROPAGATION are included.

pub fn propagate(
    &mut self,
    destination: NodeDestination,
    excluded_peers: Vec<NodeId>
) -> &mut Self

pub fn flood(&mut self, excluded: Vec<NodeId>) -> &mut Self

Set broadcast_strategy to Flood

pub fn random(&mut self, n: usize) -> &mut Self

Set broadcast_strategy to Random.

pub fn with_destination(&mut self, destination: NodeDestination) -> &mut Self

Set destination field in message header.

pub fn with_encryption(&mut self, encryption: OutboundEncryption) -> &mut Self

Set encryption mode for message.

pub fn with_discovery(&mut self, is_enabled: bool) -> &mut Self

Set to true to enable discovery, otherwise false

pub fn with_dht_message_type(
    &mut self,
    message_type: DhtMessageType
) -> &mut Self

Set the DHT message type

pub fn add_message_flag(&mut self, flag: DhtMessageFlags) -> &mut Self

Add a DhtMessageFlag to the header

pub fn with_dht_header(&mut self, dht_header: DhtMessageHeader) -> &mut Self

Override the DHtHeader of a message(s) with the given header

pub fn force_origin(&mut self) -> &mut Self

Force the message origin to be included in the message. The origin is usually not included in messages without encryption, however this setting will force the message origin and signature to be included.

pub fn finish(&mut self) -> FinalSendMessageParams

Return the final SendMessageParams

Trait Implementations

impl Clone for SendMessageParams

fn clone(&self) -> SendMessageParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendMessageParams

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

Formats the value using the given formatter.

impl Default for SendMessageParams

fn default() -> Self

Returns the "default value" for a type.