Struct comms_service::CommsControlBlock

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>>,
}

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.

Methods

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>

Creates a new instance of the CommsControlBlock

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.