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

High level management interface for BLE transports

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

To register additional connections on an already initialised BleTransport, use ble.connect(). To listen for incoming connections use ble.listen()

use ockam_transport_ble::{BleClient, BleTransport};
use ockam_transport_ble::driver::btleplug::BleAdapter;
    // Create a ble_client
    let ble_adapter = BleAdapter::try_new().await?;
    let ble_client = BleClient::with_adapter(ble_adapter);

    // Initialize the BLE Transport.
    let ble = BleTransport::create(&ctx).await?;

    // Try to connect to BleServer
    ble.connect(ble_client, "ockam_ble_1".to_string()).await?;

Implementations§

source§

impl BleTransport

source

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

Create a new BLE transport and router for the current node

source

pub async fn connect<A: BleClientDriver + BleStreamDriver + Send + 'static, S: AsRef<str> + Debug>( &self, ble_client: BleClient<A>, peer: S ) -> Result<()>

Establish an outgoing BLE connection on an existing transport

Starts a new pair of Ble connection workers

One worker handles outgoing messages, while another handles incoming messages. The local worker address is chosen based on the peer the worker is meant to be connected to.

source

pub async fn listen<A: BleServerDriver + BleStreamDriver + Send + 'static, S: AsRef<str> + Debug>( &self, ble_server: BleServer<A>, listen_addr: S ) -> Result<()>

Start listening to incoming connections on an existing transport

Trait Implementations§

source§

impl AsyncTryClone for BleTransport

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