Struct solana::cluster_info::ClusterInfo

pub struct ClusterInfo {
    pub gossip: CrdsGossip,
    // some fields omitted
}

Fields

gossip: CrdsGossip

The network

Methods

impl ClusterInfo

pub fn new_with_invalid_keypair(contact_info: ContactInfo) -> Self

Without a valid keypair gossip will not function. Only useful for tests.

pub fn new(contact_info: ContactInfo, keypair: Arc<Keypair>) -> Self

pub fn insert_self(&mut self, contact_info: ContactInfo)

pub fn insert_info(&mut self, contact_info: ContactInfo)

pub fn set_entrypoint(&mut self, entrypoint: ContactInfo)

pub fn id(&self) -> Pubkey

pub fn lookup(&self, id: &Pubkey) -> Option<&ContactInfo>

pub fn my_data(&self) -> ContactInfo

pub fn contact_info_trace(&self) -> String

pub fn push_epoch_slots(&mut self, id: Pubkey, root: u64, slots: BTreeSet<u64>)

pub fn push_vote(&mut self, vote: Transaction)

pub fn get_votes(&self, since: u64) -> (Vec<Transaction>, u64)

Get votes in the crds

• since - The timestamp of when the vote inserted must be greater than since. This allows the bank to query for new votes only.

• return - The votes, and the max timestamp from the new set.

pub fn get_epoch_state_for_node(
    &self,
    pubkey: &Pubkey,
    since: Option<u64>
) -> Option<(&EpochSlots, u64)>

pub fn get_gossiped_root_for_node(
    &self,
    pubkey: &Pubkey,
    since: Option<u64>
) -> Option<u64>

pub fn get_contact_info_for_node(&self, pubkey: &Pubkey) -> Option<&ContactInfo>

pub fn purge(&mut self, now: u64)

pub fn rpc_peers(&self) -> Vec<ContactInfo>

pub fn gossip_peers(&self) -> Vec<ContactInfo>

pub fn tvu_peers(&self) -> Vec<ContactInfo>

all peers that have a valid tvu port.

pub fn storage_peers(&self) -> Vec<ContactInfo>

all peers that have a valid storage addr

pub fn retransmit_peers(&self) -> Vec<ContactInfo>

all peers that have a valid tvu

pub fn is_replicator(contact_info: &ContactInfo) -> bool

pub fn shuffle_peers_and_index<S: BuildHasher>(
    &self,
    stakes: Option<&HashMap<Pubkey, u64, S>>,
    rng: ChaChaRng
) -> (usize, Vec<ContactInfo>)

Return sorted Retransmit peers and index of Self.id() as if it were in that list

pub fn sorted_tvu_peers(
    &self,
    stakes: Option<&HashMap<Pubkey, u64>>,
    rng: ChaChaRng
) -> Vec<ContactInfo>

pub fn tpu_peers(&self) -> Vec<ContactInfo>

compute broadcast table

pub fn describe_data_plane(nodes: usize, fanout: usize) -> (usize, Vec<usize>)

Given a node count and fanout, it calculates how many layers are needed and at what index each layer begins.

pub fn broadcast<I>(
    &self,
    s: &UdpSocket,
    blobs: I,
    stakes: Option<&HashMap<Pubkey, u64>>
) -> Result<()> where
    I: IntoIterator,
    I::Item: Borrow<SharedBlob>, 

broadcast messages from the leader to layer 1 nodes

Remarks

pub fn retransmit_to(
    obj: &Arc<RwLock<Self>>,
    peers: &[ContactInfo],
    blob: &SharedBlob,
    slot_leader_pubkey: Option<Pubkey>,
    s: &UdpSocket,
    forwarded: bool
) -> Result<()>

retransmit messages to a list of nodes

Remarks

We need to avoid having obj locked while doing a io, such as the send_to

pub fn window_index_request_bytes(
    &self,
    slot: u64,
    blob_index: u64
) -> Result<Vec<u8>>

pub fn repair_request(
    &self,
    repair_request: &RepairType
) -> Result<(SocketAddr, Vec<u8>)>

pub fn map_repair_request(&self, repair_request: &RepairType) -> Result<Vec<u8>>

pub fn gossip(
    obj: Arc<RwLock<Self>>,
    bank_forks: Option<Arc<RwLock<BankForks>>>,
    blob_sender: BlobSender,
    exit: &Arc<AtomicBool>
) -> JoinHandle<()>

randomly pick a node and ask them for updates asynchronously

pub fn listen(
    me: Arc<RwLock<Self>>,
    blocktree: Option<Arc<Blocktree>>,
    bank_forks: Option<Arc<RwLock<BankForks>>>,
    requests_receiver: BlobReceiver,
    response_sender: BlobSender,
    exit: &Arc<AtomicBool>
) -> JoinHandle<()>

pub fn gossip_node(
    id: &Pubkey,
    gossip_addr: &SocketAddr
) -> (ContactInfo, UdpSocket)

An alternative to Spy Node that has a valid gossip address and fully participate in Gossip.

pub fn spy_node(id: &Pubkey) -> (ContactInfo, UdpSocket)

A Node with invalid ports to spy on gossip via pull requests

Trait Implementations

impl Clone for ClusterInfo

fn clone(&self) -> ClusterInfo

Returns a copy of the value.

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

Performs copy-assignment from source.