pub struct Socket<Req, Resp> { /* private fields */ }
Expand description
A hRPC socket.
Sockets only handle pings if you call .receive_message()
continously.
See the respective socket transports used for more information on their behaviour.
The socket transports are located in crate::common::transport
.
Implementations
sourceimpl<Req, Resp> Socket<Req, Resp>
impl<Req, Resp> Socket<Req, Resp>
sourcepub async fn send_error(&mut self, err: HrpcError) -> Result<(), SocketError>
pub async fn send_error(&mut self, err: HrpcError) -> Result<(), SocketError>
Send an error over the socket.
sourceimpl<Req, Resp> Socket<Req, Resp> where
Req: PbMsg,
Resp: PbMsg + Default,
impl<Req, Resp> Socket<Req, Resp> where
Req: PbMsg,
Resp: PbMsg + Default,
sourcepub async fn receive_message(&mut self) -> Result<Resp, SocketError>
pub async fn receive_message(&mut self) -> Result<Resp, SocketError>
Receive a message from the socket.
Notes
- This will block until getting a message (unless an error occurs).
- This will handle ping messages.
sourcepub async fn send_message(&mut self, req: Req) -> Result<(), SocketError>
pub async fn send_message(&mut self, req: Req) -> Result<(), SocketError>
Send a message over the socket.
sourcepub async fn ping(&mut self) -> Result<(), SocketError>
pub async fn ping(&mut self) -> Result<(), SocketError>
Send a ping over the socket.
sourcepub async fn close(self) -> Result<(), SocketError>
pub async fn close(self) -> Result<(), SocketError>
Close the socket.
sourcepub fn split(self) -> (WriteSocket<Req>, ReadSocket<Resp>)
pub fn split(self) -> (WriteSocket<Req>, ReadSocket<Resp>)
Split this socket into the write half and the read half.
sourcepub fn combine(
write: WriteSocket<Req>,
read: ReadSocket<Resp>
) -> Result<Self, CombineError>
pub fn combine(
write: WriteSocket<Req>,
read: ReadSocket<Resp>
) -> Result<Self, CombineError>
Combine a write and read half back to a socket.
Errors
- Returns
CombineError
if the socket halfs aren’t split from the same socket.
Auto Trait Implementations
impl<Req, Resp> !RefUnwindSafe for Socket<Req, Resp>
impl<Req, Resp> Send for Socket<Req, Resp>
impl<Req, Resp> Sync for Socket<Req, Resp>
impl<Req, Resp> Unpin for Socket<Req, Resp>
impl<Req, Resp> !UnwindSafe for Socket<Req, Resp>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more