pub struct Kcp<Output: Write> { /* private fields */ }
Expand description
KCP control
Implementations
sourceimpl<Output: Write> Kcp<Output>
impl<Output: Write> Kcp<Output>
sourcepub fn new(conv: u32, output: Output) -> Self
pub fn new(conv: u32, output: Output) -> Self
Creates a KCP control object, conv
must be equal in both endpoints in one connection.
output
is the callback object for writing.
conv
represents conversation.
sourcepub fn new_stream(conv: u32, output: Output) -> Self
pub fn new_stream(conv: u32, output: Output) -> Self
Creates a KCP control object in stream mode, conv
must be equal in both endpoints in one connection.
output
is the callback object for writing.
conv
represents conversation.
pub fn move_buf(&mut self)
sourcepub fn input_conv(&mut self)
pub fn input_conv(&mut self)
Get conv
from the next input
call
sourcepub fn waiting_conv(&self) -> bool
pub fn waiting_conv(&self) -> bool
Check if Kcp is waiting for the next input
sourcepub fn input(&mut self, buf: &[u8]) -> KcpResult<usize>
pub fn input(&mut self, buf: &[u8]) -> KcpResult<usize>
Call this when you received a packet from raw connection
sourcepub fn update(&mut self, current: u32) -> KcpResult<()>
pub fn update(&mut self, current: u32) -> KcpResult<()>
Update state every 10ms ~ 100ms.
Or you can ask check
when to call this again.
sourcepub fn check(&self, current: u32) -> u32
pub fn check(&self, current: u32) -> u32
Determine when you should call update
.
Return when you should invoke update
in millisec, if there is no input
/send
calling.
You can call update
in that time without calling it repeatly.
sourcepub fn set_mtu(&mut self, mtu: usize) -> KcpResult<()>
pub fn set_mtu(&mut self, mtu: usize) -> KcpResult<()>
Change MTU size, default is 1400
MTU = Maximum Transmission Unit
sourcepub fn set_interval(&mut self, interval: u32)
pub fn set_interval(&mut self, interval: u32)
Set check interval
sourcepub fn set_nodelay(
&mut self,
nodelay: bool,
interval: i32,
resend: i32,
nc: bool
)
pub fn set_nodelay(
&mut self,
nodelay: bool,
interval: i32,
resend: i32,
nc: bool
)
Set nodelay
fastest config: nodelay(true, 20, 2, true)
nodelay
: default is disable (false)
interval
: internal update timer interval in millisec, default is 100ms
resend
: 0:disable fast resend(default), 1:enable fast resend
nc
: false
: normal congestion control(default), true
: disable congestion control
sourcepub fn set_wndsize(&mut self, sndwnd: u16, rcvwnd: u16)
pub fn set_wndsize(&mut self, sndwnd: u16, rcvwnd: u16)
Set wndsize
set maximum window size: sndwnd=32
, rcvwnd=32
by default
sourcepub fn set_rx_minrto(&mut self, rto: u32)
pub fn set_rx_minrto(&mut self, rto: u32)
Set rx_minrto
sourcepub fn set_fast_resend(&mut self, fr: u32)
pub fn set_fast_resend(&mut self, fr: u32)
Set fastresend
sourcepub fn header_len() -> usize
pub fn header_len() -> usize
KCP header size
sourcepub fn set_maximum_resend_times(&mut self, dead_link: u32)
pub fn set_maximum_resend_times(&mut self, dead_link: u32)
Set maximum resend times
sourcepub fn is_dead_link(&self) -> bool
pub fn is_dead_link(&self) -> bool
Check if KCP connection is dead (resend times excceeded)
Trait Implementations
Auto Trait Implementations
impl<Output> RefUnwindSafe for Kcp<Output> where
Output: RefUnwindSafe,
impl<Output> Send for Kcp<Output> where
Output: Send,
impl<Output> Sync for Kcp<Output> where
Output: Sync,
impl<Output> Unpin for Kcp<Output> where
Output: Unpin,
impl<Output> UnwindSafe for Kcp<Output> where
Output: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more