Struct citadel_sdk::prelude::GroupChannel

pub struct GroupChannel { /* private fields */ }

Implementations

impl GroupChannel

pub fn new( node_remote: NodeRemote, tx: Sender<SessionRequest>, key: MessageGroupKey, ticket: Ticket, implicated_cid: u64, recv: UnboundedReceiver<GroupBroadcastPayload>, ) -> GroupChannel

pub fn key(&self) -> MessageGroupKey

Returns the group key of the channel

pub async fn recv(&mut self) -> Option<GroupBroadcastPayload>

Receives the next element from the channel

pub fn split(self) -> (GroupChannelSendHalf, GroupChannelRecvHalf)

Splits the channel in two

pub fn cid(&self) -> u64

Methods from Deref<Target = GroupChannelSendHalf>

pub async fn send_message(&self, message: SecBuffer) -> Result<(), NetworkError>

Broadcasts a message to the group

pub async fn kick(&self, peer: u64) -> Result<(), NetworkError>

Kicks a peer from the group. User must be owner

pub async fn kick_all<T>(&self, peers: T) -> Result<(), NetworkError>

where T: Into<Vec<u64>>,

Kicks a set of peers from the group. User must be owner

pub async fn invite(&self, peer_cid: u64) -> Result<(), NetworkError>

Invites a single user to the group

pub async fn invite_all<T>(&self, peers: T) -> Result<(), NetworkError>

where T: Into<Vec<u64>>,

Invites all listed members to the group

pub async fn leave(&self) -> Result<(), NetworkError>

Leaves the group

pub async fn end(&self) -> Result<(), NetworkError>

Ends the group

Trait Implementations

impl Debug for GroupChannel

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

Formats the value using the given formatter.

impl Deref for GroupChannel

type Target = GroupChannelSendHalf

The resulting type after dereferencing.

fn deref(&self) -> &<GroupChannel as Deref>::Target

Dereferences the value.