Struct comms_service::CommsControlBlock

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

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

Fields

read: Option<Arc<ReadFn<T>>>

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

write: Vec<Arc<WriteFn<T>>>

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

read_conn: T

Gateway connection to read from.

write_conn: T

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).

ground_ip: Ipv4Addr

IP address of the ground gateway.

satellite_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.

ground_port: Option<u16>

Specifies the port to which the ground gateway is bound.

Methods

impl<T: Clone> CommsControlBlock<T>

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

Creates a new instance of the CommsControlBlock

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.