Struct tox_packet::dht::PingRequest

pub struct PingRequest {
    pub pk: PublicKey,
    pub nonce: Nonce,
    pub payload: Vec<u8>,
}

Ping request packet struct. Every 60 seconds DHT node sends PingRequest packet to peers to check whether it is alive. When PingRequest is received DHT node should respond with PingResponse that contains the same ping id inside it's encrypted payload as it got from PingRequest. If PingResponse doesn't arrive for 122 seconds the DHT node removes peer from ktree and marks it as offline if the peer is known friend.

https://zetok.github.io/tox-spec/#dht-packet

Length	Content
1	0x00
32	Public Key
24	Nonce
25	Payload

where Payload is encrypted PingRequestPayload

Fields

pk: PublicKey

public key used for payload encryption

nonce: Nonce

one time serial number

payload: Vec<u8>

encrypted payload

Implementations

impl PingRequest

pub fn new(
    shared_secret: &PrecomputedKey,
    pk: &PublicKey,
    payload: &PingRequestPayload
) -> PingRequest

create new PingRequest object

pub fn get_payload(
    &self,
    shared_secret: &PrecomputedKey
) -> Result<PingRequestPayload, GetPayloadError>

Decrypt payload and try to parse it as PingRequestPayload.

Returns Error in case of failure:

• fails to decrypt
• fails to parse as given packet type

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 Eq for PingRequest

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 StructuralEq for PingRequest

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