Struct Keepalive

pub struct Keepalive {
    pub last_received_position: u64,
    pub data: BytesMut,
    /* private fields */
}

KEEPALIVE Frame (0x03)

• Keepalive frames MUST always use Stream ID 0 as they pertain to the Connection.

• Keepalive frames MUST be initiated by the client and sent periodically with the FrameFlags::RESPOND flag set.

• Keepalive frames MAY be initiated by the server and sent upon application request with the FrameFlags::RESPOND flag set.

• Reception of a KEEPALIVE frame with the FrameFlags::RESPOND flag set MUST cause a client or server to send back a KEEPALIVE with the FrameFlags::RESPOND flag NOT set. The data in the received Keepalive MUST be echoed back in the generated Keepalive.

• Reception of a Keepalive by a server indicates to the server that the client is alive.

• Reception of a Keepalive by a client indicates to the client that the server is alive.

Frame Contents

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Stream ID = 0                         |
+-----------+-+-+-+-------------+-------------------------------+
|Frame Type |0|0|R|    Flags    |
+-----------+-+-+-+-------------+-------------------------------+
|0|                  Last Received Position                     |
+                                                               +
|                                                               |
+---------------------------------------------------------------+
                              Data

Fields

last_received_position: u64

Last Received Position: Unsigned 63-bit long of Resume Last Received Position. Value MUST be > 0.

(optional. Set to all 0s when not supported.)

data: BytesMut

Data attached to a KEEPALIVE.

Implementations

impl Keepalive

pub const fn builder() -> KeepaliveBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for Keepalive

fn clone(&self) -> Keepalive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keepalive

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

Formats the value using the given formatter.

impl Decoder for Keepalive

type Error = Error

The type of error that can occur if decoding fails.

fn decode(__buf: &mut BytesMut) -> Result<Self, Self::Error>

Decodes a value from the given buffer.

fn has_enough_bytes(_buf: &BytesMut) -> bool

Returns true if the given buffer can be decoded.

impl Encoder for Keepalive

type Error = Error

The type of error that can occur if encoding fails.

fn encode(input: &Self, __buf: &mut BytesMut) -> Result<(), Self::Error>

Encodes the given input into the output buffer.

fn size_of(input: &Self) -> usize

Returns the number of bytes required to encode the given input.

impl FrameVariant for Keepalive

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

const REQUIRED_FLAGS: FrameFlags = _

Flags that must be set for a variant.

impl From<Keepalive> for Frame

fn from(value: Keepalive) -> Self

Converts to this type from the input type.