Struct tox_packet::relay::PingRequest

pub struct PingRequest {
    pub ping_id: u64,
}

Sent by both client and server, both will respond. Ping packets are used to know if the other side of the connection is still live. TCP when established doesn't have any sane timeouts (1 week isn't sane) so we are obliged to have our own way to check if the other side is still live. Ping ids can be anything except 0, this is because of how toxcore sets the variable storing the ping_id that was sent to 0 when it receives a pong response which means 0 is invalid.

The server should send ping packets every X seconds (toxcore TCP_server sends them every 30 seconds and times out the peer if it doesn't get a response in 10). The server should respond immediately to ping packets with pong packets.

Serialized form:

Length	Content
1	0x04
8	ping_id in BigEndian

Fields

ping_id: u64

The id of ping

Trait Implementations

impl Clone for PingRequest

pub fn clone(&self) -> PingRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PingRequest

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

Formats the value using the given formatter.

impl FromBytes for PingRequest

pub fn from_bytes(i: &[u8]) -> IResult<&[u8], PingRequest, (&[u8], ErrorKind)>

Deserialize struct using nom from raw bytes

impl PartialEq<PingRequest> for PingRequest

pub fn eq(&self, other: &PingRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &PingRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for PingRequest

impl ToBytes for PingRequest

pub fn to_bytes<'a>(
    &self,
    buf: (&'a mut [u8], usize)
) -> Result<(&'a mut [u8], usize), GenError>

Serialize struct into raw bytes using cookie_factory