Struct shell_protocol::ShellProtocol

pub struct ShellProtocol { /* fields omitted */ }

Shell Service Protocol structure

This structure is only intended for usage inside of the shell service. It is not required for usage by shell clients.

Methods

impl Protocol

pub fn new(
    channel_protocol: ChannelProtocol,
    channel_id: u32,
    process: Box<ProcessHandler>
) -> Self

Create new instance of shell protocol structure

Arguments

• channel_protocol - Instance of ChannelProtocol
• channel_id - Channel ID of shell session
• process - Instance of ProcessHandler

pub fn message_engine<F>(
    &mut self,
    pump: F,
    timeout: Duration
) -> Result<(), ProtocolError> where
    F: Fn(Duration) -> Result<(ChannelMessage, SocketAddr), ProtocolError>, 

Listen for and process shell protocol messages

Arguments

• pump - Function which returns the next message for processing
• timeout - Maximum time to listen for a single message

Errors

If this function encounters any errors, it will return an error message string