Improved documentation on IrcTransport.
This commit is contained in:
parent
e220e90c58
commit
99347f536c
1 changed files with 3 additions and 2 deletions
|
@ -1,4 +1,5 @@
|
||||||
//! An IRC transport that wraps an IRC-framed stream to provide automatic PING replies.
|
//! An IRC transport that wraps an IRC-framed stream to provide a number of features including
|
||||||
|
//! automatic PING replies, automatic sending of PINGs, and message rate-limiting.
|
||||||
use std::sync::{Arc, RwLock, RwLockReadGuard};
|
use std::sync::{Arc, RwLock, RwLockReadGuard};
|
||||||
use std::time::{Duration, Instant};
|
use std::time::{Duration, Instant};
|
||||||
|
|
||||||
|
@ -13,7 +14,7 @@ use error;
|
||||||
use client::data::Config;
|
use client::data::Config;
|
||||||
use proto::{Command, IrcCodec, Message};
|
use proto::{Command, IrcCodec, Message};
|
||||||
|
|
||||||
/// An IRC transport that handles automatically replying to PINGs.
|
/// An IRC transport that handles core functionality.
|
||||||
pub struct IrcTransport<T>
|
pub struct IrcTransport<T>
|
||||||
where
|
where
|
||||||
T: AsyncRead + AsyncWrite,
|
T: AsyncRead + AsyncWrite,
|
||||||
|
|
Loading…
Add table
Reference in a new issue