Struct comms_service::CommsControlBlock

source · [−]

pub struct CommsControlBlock<Connection: Clone> {
    pub read: Option<Arc<ReadFn<Connection>>>,
    pub write: Vec<Arc<WriteFn<Connection>>>,
    pub read_conn: Connection,
    pub write_conn: Connection,
    pub max_num_handlers: u16,
    pub timeout: u64,
    pub ip: Ipv4Addr,
    pub downlink_ports: Option<Vec<u16>>,
}

Expand description

Struct that holds configuration data to allow users to set up a Communication Service.

Fields

read: Option<Arc<ReadFn<Connection>>>

Function pointer to a function that defines how to read from a gateway.

write: Vec<Arc<WriteFn<Connection>>>

Function pointers to functions that define methods for writing data over a gateway.

read_conn: Connection

Gateway connection to read from.

write_conn: Connection

Gateway connection to write to.

max_num_handlers: u16

Maximum number of concurrent message handlers allowed.

timeout: u64

Timeout for the completion of GraphQL operations within message handlers (in milliseconds).

ip: Ipv4Addr

IP address of the computer that is running the communication service.

downlink_ports: Option<Vec<u16>>

Optional list of ports used by downlink endpoints that send messages to the ground. Each port in the list will be used by one downlink endpoint.

Implementations

source

impl<Connection: Clone> CommsControlBlock<Connection>

source

pub fn new(
 read: Option<Arc<ReadFn<Connection>>>,
 write: Vec<Arc<WriteFn<Connection>>>,
 read_conn: Connection,
 write_conn: Connection,
 config: CommsConfig
) -> CommsResult<Self>

Creates a new instance of the CommsControlBlock

Trait Implementations

source

impl<Connection: Clone + Clone> Clone for CommsControlBlock<Connection>

source

fn clone(&self) -> CommsControlBlock<Connection>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<Connection: Clone + Debug> Debug for CommsControlBlock<Connection>

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<Connection> !RefUnwindSafe for CommsControlBlock<Connection>

impl<Connection> Send for CommsControlBlock<Connection> where
Connection: Send,

impl<Connection> Sync for CommsControlBlock<Connection> where
Connection: Sync,

impl<Connection> Unpin for CommsControlBlock<Connection> where
Connection: Unpin,

impl<Connection> !UnwindSafe for CommsControlBlock<Connection>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CloneAny for T where
T: Any + Clone,

fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>

fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where
T: Send,

fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where
T: Sync,

fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where
T: Send + Sync,

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct comms_service::CommsControlBlock

Fields

Implementations

impl<Connection: Clone> CommsControlBlock<Connection>

pub fn new( read: Option<Arc<ReadFn<Connection>>>, write: Vec<Arc<WriteFn<Connection>>>, read_conn: Connection, write_conn: Connection, config: CommsConfig) -> CommsResult<Self>

Trait Implementations

impl<Connection: Clone + Clone> Clone for CommsControlBlock<Connection>

fn clone(&self) -> CommsControlBlock<Connection>

fn clone_from(&mut self, source: &Self)

impl<Connection: Clone + Debug> Debug for CommsControlBlock<Connection>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Auto Trait Implementations

impl<Connection> !RefUnwindSafe for CommsControlBlock<Connection>

impl<Connection> Send for CommsControlBlock<Connection> where Connection: Send,

impl<Connection> Sync for CommsControlBlock<Connection> where Connection: Sync,

impl<Connection> Unpin for CommsControlBlock<Connection> where Connection: Unpin,

impl<Connection> !UnwindSafe for CommsControlBlock<Connection>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneAny for T where T: Any + Clone,

fn clone_any(&self) -> Box<dyn CloneAny + 'static, Global>

fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where T: Send,

fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where T: Sync,

fn clone_any_send_sync( &self) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where T: Send + Sync,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

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

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

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

impl<T> DebugAny for T where T: Any + Debug,

impl<T> UnsafeAny for T where T: Any,

pub fn new(
read: Option<Arc<ReadFn<Connection>>>,
write: Vec<Arc<WriteFn<Connection>>>,
read_conn: Connection,
write_conn: Connection,
config: CommsConfig
) -> CommsResult<Self>

impl<Connection> Send for CommsControlBlock<Connection> where
Connection: Send,

impl<Connection> Sync for CommsControlBlock<Connection> where
Connection: Sync,

impl<Connection> Unpin for CommsControlBlock<Connection> where
Connection: Unpin,

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

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

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

impl<T> CloneAny for T where
T: Any + Clone,

fn clone_any_send(&self) -> Box<dyn CloneAny + Send + 'static, Global> where
T: Send,

fn clone_any_sync(&self) -> Box<dyn CloneAny + Sync + 'static, Global> where
T: Sync,

fn clone_any_send_sync(
&self
) -> Box<dyn CloneAny + Sync + Send + 'static, Global> where
T: Send + Sync,

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

impl<T> ToOwned for T where
T: Clone,

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

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

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

impl<T> DebugAny for T where
T: Any + Debug,

impl<T> UnsafeAny for T where
T: Any,