Struct kcp::Kcp
[−]
[src]
pub struct Kcp<Output: Write> { /* fields omitted */ }
KCP control
Methods
impl<Output: Write> Kcp<Output>[src]
fn new(conv: u32, output: Output) -> Self[src]
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.
fn new_stream(conv: u32, output: Output) -> Self[src]
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.
fn peeksize(&self) -> KcpResult<usize>[src]
Check buffer size without actually consuming it
fn recv(&mut self, buf: &mut [u8]) -> KcpResult<usize>[src]
Receive data from buffer
fn send(&mut self, buf: &[u8]) -> KcpResult<usize>[src]
Send bytes into buffer
fn input_conv(&mut self)[src]
Get conv from the next input call
fn waiting_conv(&self) -> bool[src]
Check if Kcp is waiting for the next input
fn set_conv(&mut self, conv: u32)[src]
Set conv value
fn conv(&self) -> u32[src]
Get conv
fn input(&mut self, buf: &[u8]) -> KcpResult<usize>[src]
Call this when you received a packet from raw connection
fn flush_ack(&mut self) -> KcpResult<()>[src]
Flush pending ACKs
fn flush(&mut self) -> KcpResult<()>[src]
Flush pending data in buffer.
fn update(&mut self, current: u32) -> KcpResult<()>[src]
Update state every 10ms ~ 100ms.
Or you can ask check when to call this again.
fn check(&self, current: u32) -> u32[src]
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.
fn set_mtu(&mut self, mtu: usize) -> KcpResult<()>[src]
Change MTU size, default is 1400
MTU = Maximum Transmission Unit
fn mtu(&self) -> usize[src]
Get MTU
fn set_interval(&mut self, interval: u32)[src]
Set check interval
fn set_nodelay(&mut self, nodelay: bool, interval: i32, resend: i32, nc: bool)[src]
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
fn set_wndsize(&mut self, sndwnd: u16, rcvwnd: u16)[src]
Set wndsize
set maximum window size: sndwnd=32, rcvwnd=32 by default
fn snd_wnd(&self) -> u16[src]
snd_wnd Send window
fn rcv_wnd(&self) -> u16[src]
rcv_wnd Receive window
fn wait_snd(&self) -> usize[src]
Get waitsnd, how many packet is waiting to be sent
fn set_rx_minrto(&mut self, rto: u32)[src]
Set rx_minrto
fn set_fast_resend(&mut self, fr: u32)[src]
Set fastresend
fn header_len() -> usize[src]
KCP header size
fn is_stream(&self) -> bool[src]
Enabled stream or not
fn mss(&self) -> u32[src]
Maximum Segment Size
fn set_maximum_resend_times(&mut self, dead_link: u32)[src]
Set maximum resend times
fn is_dead_link(&self) -> bool[src]
Check if KCP connection is dead (resend times excceeded)