Struct h2::proto::go_away::GoAway

pub(super) struct GoAway {
    close_now: bool,
    going_away: Option<GoingAway>,
    is_user_initiated: bool,
    pending: Option<GoAway>,
}

Manages our sending of GOAWAY frames.

Fields

close_now: bool

Whether the connection should close now, or wait until idle.

going_away: Option<GoingAway>

Records if we’ve sent any GOAWAY before.

is_user_initiated: bool

Whether the user started the GOAWAY by calling abrupt_shutdown.

pending: Option<GoAway>

A GOAWAY frame that must be buffered in the Codec immediately.

Implementations

impl GoAway

pub fn new() -> Self

pub fn go_away(&mut self, f: GoAway)

Enqueue a GOAWAY frame to be written.

The connection is expected to continue to run until idle.

pub fn go_away_now(&mut self, f: GoAway)

pub fn go_away_from_user(&mut self, f: GoAway)

pub fn is_going_away(&self) -> bool

Return if a GOAWAY has ever been scheduled.

pub fn is_user_initiated(&self) -> bool

pub fn going_away(&self) -> Option<&GoingAway>

Returns the going away info, if any.

pub fn should_close_now(&self) -> bool

Returns if the connection should close now, or wait until idle.

pub fn should_close_on_idle(&self) -> bool

Returns if the connection should be closed when idle.

pub fn send_pending_go_away<T, B>( &mut self, cx: &mut Context<'_>, dst: &mut Codec<T, B>, ) -> Poll<Option<Result<Reason>>>

where T: AsyncWrite + Unpin, B: Buf,

Try to write a pending GOAWAY frame to the buffer.

If a frame is written, the Reason of the GOAWAY is returned.

Trait Implementations

impl Debug for GoAway

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

Formats the value using the given formatter.