Struct ublox_short_range::UbloxClient

pub struct UbloxClient<C, N, L> where
    C: AtatClient,
    N: 'static + ArrayLength<Option<SocketSetItem<L>>>,
    L: 'static + ArrayLength<u8>,  { /* fields omitted */ }

Implementations

impl<C, N, L> UbloxClient<C, N, L> where
    C: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

pub fn new(client: C, socket_set: &'static mut SocketSet<N, L>) -> Self

pub fn init(&self) -> Result<(), Error>

pub fn spin(&self) -> Result<(), Error>

Not implemented Not in use Not implemented

pub fn send_at<A>(&self, cmd: A) -> Result<A::Response, Error> where
    A: AtatCmd,
    <A as AtatCmd>::CommandLen: Add<EdmAtCmdOverhead>,
    <<A as AtatCmd>::CommandLen as Add<EdmAtCmdOverhead>>::Output: ArrayLength<u8>, 

Send AT command Automaticaly waraps commands in EDM context

Trait Implementations

impl<C, N, L> Dns for UbloxClient<C, N, L> where
    C: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

type Error = Error

The type returned when we have an error

fn gethostbyaddr(&self, _ip_addr: IpAddr) -> Result<String<U256>, Self::Error>

Resolve the hostname of a host, given its ip address

fn gethostbyname(
    &self,
    hostname: &str,
    _addr_type: AddrType
) -> Result<IpAddr, Self::Error>

Resolve the first ip address of a host, given its hostname and a desired address record type to look for

impl<C, N, L> TLS for UbloxClient<C, N, L> where
    C: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

fn import_certificate(
    &mut self,
    name: &str,
    certificate: &[u8]
) -> Result<(), Error>

Importing credentials enabeles their use for all further TCP connections

fn import_root_ca(&mut self, name: &str, root_ca: &[u8]) -> Result<(), Error>

Importing credentials enabeles their use for all further TCP connections

fn import_private_key(
    &mut self,
    name: &str,
    private_key: &[u8],
    password: Option<&str>
) -> Result<(), Error>

Importing credentials enabeles their use for all further TCP connections

fn enable_tls(
    &self,
    _socket: SocketHandle,
    _ca_cert_name: Option<&str>,
    _client_cert_name: Option<&str>,
    _priv_key_name: Option<&str>
) -> Result<(), Error>

impl<C, N, L> TcpClient for UbloxClient<C, N, L> where
    C: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

type Error = Error

The type returned when we have an error

type TcpSocket = SocketHandle

The type returned when we create a new TCP socket

fn socket(&self) -> Result<Self::TcpSocket, Self::Error>

Open a new TCP socket to the given address and port. The socket starts in the unconnected state.

fn connect(
    &self,
    socket: &mut Self::TcpSocket,
    remote: SocketAddr
) -> Result<(), Self::Error>

Connect to the given remote host and port.

fn is_connected(&self, socket: &Self::TcpSocket) -> Result<bool, Self::Error>

Check if this socket is still connected

fn send(
    &self,
    socket: &mut Self::TcpSocket,
    buffer: &[u8]
) -> Result<usize, Self::Error>

Write to the stream. Returns the number of bytes written is returned (which may be less than buffer.len()), or an error.

fn receive(
    &self,
    socket: &mut Self::TcpSocket,
    buffer: &mut [u8]
) -> Result<usize, Self::Error>

Receive data from the stream.

fn close(&self, socket: Self::TcpSocket) -> Result<(), Self::Error>

Close an existing TCP socket.

impl<C, N, L> UdpClient for UbloxClient<C, N, L> where
    C: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

type Error = Error

The type returned when we have an error

type UdpSocket = SocketHandle

The type returned when we create a new UDP socket

fn socket(&self) -> Result<Self::UdpSocket, Self::Error>

Allocate a socket for further use.

fn connect(
    &self,
    socket: &mut Self::UdpSocket,
    remote: SocketAddr
) -> Result<(), Self::Error>

Connect a UDP socket with a peer using a dynamically selected port. Selects a port number automatically and initializes for read/writing.

fn send(
    &self,
    socket: &mut Self::UdpSocket,
    buffer: &[u8]
) -> Result<(), Self::Error>

Send a datagram to the remote host.

fn receive(
    &self,
    socket: &mut Self::UdpSocket,
    buffer: &mut [u8]
) -> Result<(usize, SocketAddr), Self::Error>

Read a datagram the remote host has sent to us. Returns Ok(n), which means a datagram of size n has been received and it has been placed in &buffer[0..n], or an error.

fn close(&self, socket: Self::UdpSocket) -> Result<(), Self::Error>

Close an existing UDP socket.

impl<T, N, L> WifiConnectivity for UbloxClient<T, N, L> where
    T: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

fn connect(&self, options: ConnectionOptions) -> Result<(), WifiConnectionError>

Attempts to connect to a wireless network with the given connection options.

fn scan(&self) -> Result<Vec<WifiNetwork, U32>, WifiError>

fn is_connected(&self) -> bool

fn disconnect(&self) -> Result<(), WifiConnectionError>

impl<T, N, L> WifiHotspot for UbloxClient<T, N, L> where
    T: AtatClient,
    N: ArrayLength<Option<SocketSetItem<L>>>,
    L: ArrayLength<u8>, 

fn create_hotspot(
    self,
    options: ConnectionOptions,
    configuration: HotspotOptions
) -> Result<(), WifiHotspotError>

Creates wireless hotspot service for host machine.

fn stop_hotspot(&mut self) -> Result<bool, WifiHotspotError>

Stop serving a wireless network.

NOTE: All users connected will automatically be disconnected.