Struct buttplug::client::ButtplugClientMessageFuturePair

pub struct ButtplugClientMessageFuturePair {
    pub msg: ButtplugCurrentSpecClientMessage,
    pub waker: ButtplugFutureStateShared<ButtplugInternalClientMessageResult>,
}

Future state for messages sent from the client that expect a server response.

When a message is sent from the client and expects a response from the server, we'd like to know when that response arrives, and usually we'll want to wait for it. We can do so by creating a future that will be resolved when a response is received from the server.

To do this, we build a ButtplugFuture, then take its waker and pass it along with the message we send to the connector, using the ButtplugClientMessageFuturePair type. We can then expect the connector to get the response from the server, match it with our message (using something like the [ClientConnectorMessageSorter][crate::connector::ClientConnectorMessageSorter]), and set the reply in the waker we've sent along. This will resolve the future we're waiting on and allow us to continue execution.

Fields

msg: ButtplugCurrentSpecClientMessage

waker: ButtplugFutureStateShared<ButtplugInternalClientMessageResult>

Implementations

impl ButtplugClientMessageFuturePair

pub fn new(
    msg: ButtplugCurrentSpecClientMessage,
    waker: ButtplugFutureStateShared<ButtplugInternalClientMessageResult>
) -> Self