Enum shell_protocol::messages::Message

[+] Show declaration

pub enum Message {
    Exit {
        channel_id: u32,
        code: u32,
        signal: u32,
    },
    Error {
        channel_id: u32,
        message: String,
    },
    Kill {
        channel_id: u32,
        signal: Option<u32>,
    },
    List {
        channel_id: u32,
        process_list: Option<HashMap<u32, (String, u32)>>,
    },
    Pid {
        channel_id: u32,
        pid: u32,
    },
    Spawn {
        channel_id: u32,
        command: String,
        args: Option<Vec<String>>,
    },
    Stdout {
        channel_id: u32,
        data: Option<String>,
    },
    Stderr {
        channel_id: u32,
        data: Option<String>,
    },
    Stdin {
        channel_id: u32,
        data: Option<String>,
    },
}

[−] Expand description

Messages available in shell protocol

Variants

Exit

[−] Expand description

This message is sent by the shell service when a process exits

[−] Show fields

Fields of Exit

channel_id: u32

Channel ID of shell session

code: u32

Exit code

signal: u32

Exit signal

Error

[−] Expand description

This message is sent when an error occurs within the shell protocol

[−] Show fields

Fields of Error

channel_id: u32

Channel ID of shell session

message: String

Error condition encountered

Kill

[−] Expand description

This message is sent to the shell service to send a kill signal to the child process

[−] Show fields

Fields of Kill

channel_id: u32

Channel ID of shell session

signal: Option<u32>

Optional signal to use. Default is SIGKILL

List

[−] Expand description

This message is used to request and respond with the lists of processes currently running under the shell service.

[−] Show fields

Fields of List

channel_id: u32

Channel ID of shell session

process_list: Option<HashMap<u32, (String, u32)>>

Optional list of processes. No list is sent when a request is sent.

Pid

[−] Expand description

This message is sent by the shell service after a process is spawned to indicate the process' PID

[−] Show fields

Fields of Pid

channel_id: u32

Channel ID of shell session

pid: u32

PID of remote process

Spawn

[−] Expand description

This message is sent to the shell service to request a child process to be spawned.

[−] Show fields

Fields of Spawn

channel_id: u32

Channel ID of shell session

command: String

Process command to spawn

args: Option<Vec<String>>

Optional arguments to pass into command when spawning

Stdout

[−] Expand description

This message is sent by the shell service when a process has produced stdout data. The shell service will send this message with no data when the stdout pipe is closed.

[−] Show fields

Fields of Stdout

channel_id: u32

Channel ID of shell session

data: Option<String>

Optional stdout data

Stderr

[−] Expand description

This message is sent by the shell service when a process has produced stderr data. The shell service will send this message with no data when the stderr pipe is closed.

[−] Show fields

Fields of Stderr

channel_id: u32

Channel ID of shell session

data: Option<String>

Optional stdout data

Stdin

[−] Expand description

This message is sent by the shell client with stdin for a shell process. If sent without any data the shell service will close the stdin pipe.

[−] Show fields

Fields of Stdin

channel_id: u32

Channel ID of shell session

data: Option<String>

Optional stdin data

Trait Implementations

impl PartialEq<Message> for Message

[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Message) -> bool

[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

[−]

This method tests for !=.

impl Eq for Message

impl Debug for Message

[+]

[+] Show hidden undocumented items

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

[−]

Formats the value using the given formatter.