Struct medea_coturn_telnet_client::CoturnTelnetConnection

pub struct CoturnTelnetConnection(_);

Asynchronous connection to remote Coturn server via Telnet interface.

Implementations

impl CoturnTelnetConnection

pub async fn connect<A: ToSocketAddrs, B: Into<Bytes>>(
    addr: A,
    pass: B
) -> Result<CoturnTelnetConnection, CoturnTelnetError>

Opens a Telnet connection to a remote host using a TcpStream and performs authentication.

Errors

Errors if couldn’t open TcpStream or authentication failed.

pub async fn print_sessions(
    &mut self,
    username: String
) -> Result<Vec<String>, CoturnTelnetError>

Returns session IDs for Coturn server associated with the provided username.

1. Sends CoturnCliRequest::PrintSessions with the provided username.
2. Awaits for CoturnCliResponse::Sessions.

Errors

• Unable to send message to remote server.
• Transport error while waiting for server response.
• Received an unexpected (not CoturnCliResponse::Sessions) response from remote server.

pub async fn delete_session(
    &mut self,
    session_id: String
) -> Result<(), CoturnTelnetError>

Closes session on Coturn server destroying this session’s allocations and channels.

1. Sends CoturnCliRequest::CloseSession with the provided session_id.
2. Awaits for CoturnCliResponse::Ready.

Errors

• Unable to send message to remote server.
• Transport error while waiting for server response.
• Received an unexpected (not CoturnCliResponse::Ready) response from remote server.

pub async fn delete_sessions<T: IntoIterator<Item = String>>(
    &mut self,
    session_ids: T
) -> Result<(), CoturnTelnetError>

Closes multiple sessions on Coturn server destroying their allocations and channels.

For each provided session id:

1. Sends CoturnCliRequest::CloseSession with specified session id.
2. Awaits for CoturnCliResponse::Ready.

Errors

• Unable to send message to remote server.
• Transport error while waiting for server response.
• Received an unexpected (not CoturnCliResponse::Sessions) response from remote server.

pub async fn ping(&mut self) -> Result<(), CoturnTelnetError>

Pings Coturn server via Telnet.

Errors

• Unable to send message to remote server.
• Transport error while waiting for server response.
• First message received is not CoturnCliResponse::UnknownCommand.

Trait Implementations

impl Debug for CoturnTelnetConnection

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

Formats the value using the given formatter.

impl Manager<CoturnTelnetConnection, CoturnTelnetError> for Manager

This is supported on crate feature pool only.

fn create<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<CoturnTelnetConnection, CoturnTelnetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create a new instance of T

fn recycle<'life0, 'life1, 'async_trait>(
    &'life0 self,
    conn: &'life1 mut CoturnTelnetConnection
) -> Pin<Box<dyn Future<Output = RecycleResult<CoturnTelnetError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Try to recycle an instance of T returning None` if the object could not be recycled.