Struct kernel::registry::listener::Handshake

#[non_exhaustive]
pub struct Handshake<D: RegisteredDriver> {
    pub hello: D::Hello,
    pub accept: Accept<D>,
}

A connection request received from a Listener.

A Handshake contains a Hello message sent by the client, which can be used to identify the requested connection. The service may choose to accept or reject the connection, potentially using the value of the Hello message to make this decision.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hello: D::Hello

The RegisteredDriver::Hello message sent by the client to identify the requested incoming connection.

accept: Accept<D>

Accepts or rejects the handshake.

The Handshake::accept and Handshake::reject methods may be used to accept the handshake, but the Accept type provides these methods on a separate type, so that the Hello message can be moved out of the Handshake value while still allowing the connection to be accepted.

Implementations

impl<D: RegisteredDriver> Handshake<D>

pub fn accept(self, channel: KProducer<Message<D>>) -> Result<(), AcceptError>

Accept the connection, returning the provided channel to the client.

Any requests sent by the client once the connection has been accepted will now be received by the KConsumer corresponding to the provided KProducer.

Returns

• Ok([()]) if the connection was successfully accepted.
• Err(AcceptError) if the connection was canceled by the client. In this case, the client is no longer interested in the connection (and may or may not still exist), and the service may ignore this connection request.

pub fn reject(self, error: D::ConnectError) -> Result<(), AcceptError>

Reject the connection, returning the provided error to the client.

Returns

• Ok([()]) if the connection was successfully rejected and the error was received by the client.
• Err(AcceptError) if the connection was canceled by the client.