Struct adbfbinlib::ctrl::Ctrl

pub struct Ctrl {
    peer_id: PeerId,
    paths: Arc<Mutex<SearchPath>>,
    with_net: bool,
}

The controller holds user interfaces as webui, tui. It currently creates and runs the user interfaces, distributes messages and sends out messages to be used somewhere else.

Fields

peer_id: PeerId

paths: Arc<Mutex<SearchPath>>

with_net: bool

Implementations

impl Ctrl

fn new(new_id: PeerId, paths: Arc<Mutex<SearchPath>>, with_net: bool) -> Self

Create a new controller if everything fits.

Arguments

• 'peer_id' - The peer_id this client/server uses
• 'paths' - The paths that will be searched
• 'with_net' - If ctrl should consider net messages

pub fn run(
    new_id: PeerId,
    paths: Arc<Mutex<SearchPath>>,
    receiver: CReceiver<UiUpdateMsg>,
    with_net: bool,
    wait_main: WaitGroup,
    has_webui: bool,
    has_tui: bool,
    open_browser: bool,
    web_port: u16
) -> Result<(), Error>

Create a new controller if everything fits.

Arguments

• 'new_id' - The peer_id this client/server uses
• 'paths' - The paths that will be searched
• 'receiver' - The paths that will be searched
• 'with_net' - If ctrl should consider net messages
• 'wait_main' - The main thread notifier
• 'has_webui' - If webui has to be considered
• 'has_tui' - If tui has to be considered
• 'open_browser' - If browser should be automatically opened
• 'web_port' - Browser, webui port to use

fn spawn_webui(
    this: Arc<Mutex<Self>>,
    receiver: Receiver<InternalUiMsg>,
    wait_ui_sync: WaitGroup,
    thread_finisher: Sender<Finisher>,
    open_browser: bool,
    web_port: u16
) -> Result<JoinHandle<Result<(), Error>>, Error>

fn spawn_tui(
    this: Arc<Mutex<Self>>,
    resender: Sender<InternalUiMsg>,
    receiver: Receiver<InternalUiMsg>,
    sync_startup: WaitGroup,
    thread_finisher: Sender<Finisher>
) -> Result<JoinHandle<Result<(), Error>>, Error>

fn spawn_message_loop(
    receiver: CReceiver<UiUpdateMsg>,
    multiplex_send: Vec<Sender<InternalUiMsg>>
) -> Result<JoinHandle<()>, Error>

fn run_tui(
    title: String,
    paths: Vec<String>,
    with_net: bool,
    tui_receiver: Receiver<InternalUiMsg>,
    resender: Sender<InternalUiMsg>
) -> Result<(), String>

Run the UIs - there is less controlling rather than showing

fn run_webui(
    webui_receiver: Receiver<InternalUiMsg>,
    net_support: bool,
    peer_representation: PeerRepresentation,
    paths: Arc<Mutex<SearchPath>>,
    wait_ui_sync: WaitGroup,
    open_browser: bool,
    web_port: u16
) -> Result<()>

Run the controller

fn run_message_forwarding(
    receiver: &CReceiver<UiUpdateMsg>,
    multiplex_send: &Vec<Sender<InternalUiMsg>>
) -> bool

This basically wraps incoming UiUpdateMsg to InternalUiMsg which kind of defines an extra layer for convenience, and to be extended and so on.