[][src]Enum shell_protocol::messages::Message

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

Messages available in shell protocol

Variants

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

Fields of Exit

Channel ID of shell session

Exit code

Exit signal

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

Fields of Error

Channel ID of shell session

Error condition encountered

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

Fields of Kill

Channel ID of shell session

Optional signal to use. Default is SIGKILL

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

Fields of List

Channel ID of shell session

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

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

Fields of Pid

Channel ID of shell session

PID of remote process

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

Fields of Spawn

Channel ID of shell session

Process command to spawn

Optional arguments to pass into command when spawning

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.

Fields of Stdout

Channel ID of shell session

Optional stdout data

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.

Fields of Stderr

Channel ID of shell session

Optional stdout data

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.

Fields of Stdin

Channel ID of shell session

Optional stdin data

Trait Implementations

impl PartialEq<Message> for Message
[src]

impl Eq for Message
[src]

impl Debug for Message
[src]

Auto Trait Implementations

impl Send for Message

impl Sync for Message

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> From for T
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]