pub struct UdsTransport { /* private fields */ }
Expand description

High level management interface for UDS transports

Be aware that only one UdsTransport can exist per node, as it registers itself as a router for the UDS address type. Multiple calls to UdsTransport::create will fail.

To listen for incoming connections use uds.listen().

To register additional connections on an already initialised UdsTransport, use uds.connect(). This step is optional because the underlying UdsRouter is capable of lazily establishing a connection upon arrival of an initial message.

use ockam_transport_uds::UdsTransport;
let uds = UdsTransport::create(&ctx).await?;
uds.listen("/tmp/example-socket").await?; // Listen on socket `/tmp/example-socket`
uds.connect("/tmp/other-socket").await?; // And connect to `/tmp/other-socket`

The same UdsTransport can also bind to multiple sockets.

use ockam_transport_uds::UdsTransport;
let uds = UdsTransport::create(&ctx).await?;
uds.listen("/tmp/socket-one").await?; // Listen on `/tmp/socket-one`
uds.listen("/tmp/socket-two").await?; // Listen on `/tmp/socket-two`

Implementations§

source§

impl UdsTransport

source

pub async fn create(ctx: &Context) -> Result<Self>

Creates a a UDS Router and registers it with the given node Context

source

pub async fn connect<S: AsRef<str>>(&self, peer: S) -> Result<Address>

Connects the UdsTransport to the given socket peer.

use ockam_transport_uds::UdsTransport;
let uds = UdsTransport::create(&ctx).await?;
uds.connect("/tmp/socket-name").await?;
source

pub async fn disconnect<S: AsRef<str>>(&self, peer: S) -> Result<()>

Disconnects the UdsTransport from the given socket peer.

use ockam_transport_uds::UdsTransport;
let uds = UdsTransport::create(&ctx).await?;
uds.connect("/tmp/socket-name").await?;

uds.disconnect("/tmp/socket-name").await?;
source

pub async fn listen<S: AsRef<str>>(&self, bind_addr: S) -> Result<SocketAddr>

Binds the UdsTransport to listen and accept incoming connection requests to the given socket.

use ockam_transport_uds::UdsTransport;
let uds = UdsTransport::create(&ctx).await?;
uds.listen("/tmp/socket-name").await?;

Trait Implementations§

source§

impl AsyncTryClone for UdsTransport

source§

fn async_try_clone<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Try cloning a object and return an Err in case of failure.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more