tab-daemon 0.5.4

the daemon module for the tab terminal multiplexer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use super::tab::{TabOutput, TabScrollback};

use tab_api::{
    chunk::{InputChunk, OutputChunk},
    tab::{CreateTabMetadata, TabId, TabMetadata},
};

/// The CLI connection Send message.  Messaged on the CliBus, and
///
/// Generally used to Subscribe, Unsubscribe, and otherwise manage tabs.
///
/// Usage:
/// - Tx from CliService, to create, delete, edit, and retask tabs.
/// - Tx from CliService, to send stdin
/// - Rx into ListenerConnectionCarrier
#[derive(Debug, Clone, PartialEq)]
pub enum CliSend {
    /// Provides a stdin chunk for the given tab
    Input(TabId, InputChunk),
    /// Creates a tab with the given metadata.  Ignored if a tab with the given name is already active.
    CreateTab(CreateTabMetadata),
    /// Requests that any clients who are subscribed to the given tab be retasked, to the second tab
    Retask(TabId, TabId),
    /// Requests the scrollback buffer be read, and replied to as a CliRecv::Scrollback message.
    RequestScrollback(TabId),
    /// Resizes the tab to the given number of (cols, rows)
    ResizeTab(TabId, (u16, u16)),
    /// Closes the tab with the given ID
    CloseTab(TabId),
    /// Disconnects any sessions for the tab with the given ID
    DisconnectTab(TabId),
    /// Shuts down the Daemon and all PTY processes
    GlobalShutdown,
}

/// The CLI connection Recv message.  
/// The main point of contact for a CLI connection.  
/// Messaged on the CliBus.
///
/// Used to receive tab lifecycle events, and stdout.
///
/// Usage:
/// - Tx from ListenerConnectionCarrier, for subscribed tabs which have been subscribed to by the CLI connection.
/// - Rx into CliService, to be forwarded on the websocket.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CliRecv {
    /// A notification that a tab with the given metadata has started, and is ready for subscriptions.
    TabStarted(TabMetadata),
}

/// A message sent to the command client's tab subscription service
/// Maintains subscription state, buffers, and filters messages based on their byte position
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CliSubscriptionRecv {
    Subscribe(TabId),
    Unsubscribe(TabId),
    /// A notification that scrollback is available for the given tab.
    /// Receivers can clone the scrollback buffer with TabScrollback::scrollback
    Scrollback(TabScrollback),
    /// An indexed stdout chunk, for the given tab
    Output(TabOutput),
    /// A notification that a tab has been retasked.  The client may need to request scrollback and change their subscriptions.
    /// If the second argument is None, the client should disconnect.
    Retask(TabId, Option<TabId>),
    /// Notification that a tab has stopped
    Stopped(TabId),
}

/// A message sent by the client's subscription state service
/// Represented with the current state of the subscription, contains tab updates and output chunks
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CliSubscriptionSend {
    Retask(TabId),
    Disconnect,
    Output(TabId, OutputChunk),
    Stopped(TabId),
}

/// Terminates the websocket connection & supporing services.
/// The daemon is not affected.  If you want to stop the daemon,
/// use CliSend::GlobalShutdown
#[derive(Debug, Clone)]
pub struct CliShutdown {}