Struct TransitConnector

pub struct TransitConnector { /* private fields */ }

👎Deprecated since 0.7.0: This will be a private type in the future. Open an issue if you require access to protocol intrinsics in the future

A partially set up Transit connection.

For the transit handshake, each side generates a Hints with all the information to find the other. You need to exchange it (as in: send yours, receive theirs) with them. This is outside of the transit protocol, because we are protocol agnostic.

Implementations

impl TransitConnector

pub fn our_abilities(&self) -> &Abilities

The abilities that we’ve sent to the other side

pub fn our_hints(&self) -> &Arc<Hints>

Send this one to the other side

pub async fn connect( self, is_leader: bool, transit_key: Key<TransitKey>, their_abilities: Abilities, their_hints: Arc<Hints>, ) -> Result<(Transit, TransitInfo), TransitConnectError>

Forwards to either leader_connect or follower_connect.

It usually is better to call the respective functions directly by their name, as it makes them less easy to confuse (confusion may still happen though). Nevertheless, sometimes it is desirable to use the same code for both sides and only track the side with a boolean.

pub async fn leader_connect( self, transit_key: Key<TransitKey>, their_abilities: Abilities, their_hints: Arc<Hints>, ) -> Result<(Transit, TransitInfo), TransitConnectError>

Connect to the other side, as sender.

pub async fn follower_connect( self, transit_key: Key<TransitKey>, their_abilities: Abilities, their_hints: Arc<Hints>, ) -> Result<(Transit, TransitInfo), TransitConnectError>

Connect to the other side, as receiver