Class: HrrRbSsh::Message::SSH_MSG_CHANNEL_REQUEST

Inherits:
Object
  • Object
show all
Includes:
Codable
Defined in:
lib/hrr_rb_ssh/message/098_ssh_msg_channel_request.rb

Defined Under Namespace

Modules: SignalName, TerminalMode

Constant Summary collapse

ID = 
self.name.split('::').last
VALUE = 
98
TERMINAL_MODE_INV = 
TerminalMode.constants.map{|c| [TerminalMode.const_get(c), c.to_s]}.inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
DEFINITION = 
[
  #[DataType, Field Name]
  [DataType::Byte,      :'message number'],
  [DataType::Uint32,    :'recipient channel'],
  [DataType::String,    :'request type'],
  [DataType::Boolean,   :'want reply'],
]
PTY_REQ_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "pty-req"],
  [DataType::String,    :'TERM environment variable value'],
  [DataType::Uint32,    :'terminal width, characters'],
  [DataType::Uint32,    :'terminal height, rows'],
  [DataType::Uint32,    :'terminal width, pixels'],
  [DataType::Uint32,    :'terminal height, pixels'],
  [DataType::String,    :'encoded terminal modes'],
]
X11_REQ_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "x11-req"],
  [DataType::Boolean,   :'single connection'],
  [DataType::String,    :'x11 authentication protocol'],
  [DataType::String,    :'x11 authentication cookie'],
  [DataType::Uint32,    :'x11 screen number'],
]
ENV_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   'request type' : "env"],
  [DataType::String,    :'variable name'],
  [DataType::String,    :'variable value'],
]
SHELL_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "shell"],
]
EXEC_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "exec"],
  [DataType::String,    :'command'],
]
SUBSYSTEM_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "subsystem"],
  [DataType::String,    :'subsystem name'],
]
WINDOW_CHANGE_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "window-change"],
  [DataType::Uint32,    :'terminal width, columns'],
  [DataType::Uint32,    :'terminal height, rows'],
  [DataType::Uint32,    :'terminal width, pixels'],
  [DataType::Uint32,    :'terminal height, pixels'],
]
XON_XOFF_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "xon-xoff"],
  [DataType::Boolean,   :'client can do'],
]
SIGNAL_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "signal"],
  [DataType::String,    :'signal name'],
]
EXIT_STATUS_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "exit-status"],
  [DataType::Uint32,    :'exit status'],
]
EXIT_SIGNAL_DEFINITION = 
[
  #[DataType, Field Name]
  #[DataType::String,   :'request type' : "exit-signal"],
  [DataType::String,    :'signal name'],
  [DataType::Boolean,   :'core dumped'],
  [DataType::String,    :'error message'],
  [DataType::String,    :'language tag'],
]
CONDITIONAL_DEFINITION = 
{
  # Field Name => {Field Value => Conditional Definition}
  :'request type' => {
    "pty-req"       => PTY_REQ_DEFINITION,
    "x11-req"       => X11_REQ_DEFINITION,
    "env"           => ENV_DEFINITION,
    "shell"         => SHELL_DEFINITION,
    "exec"          => EXEC_DEFINITION,
    "subsystem"     => SUBSYSTEM_DEFINITION,
    "window-change" => WINDOW_CHANGE_DEFINITION,
    "xon-xoff"      => XON_XOFF_DEFINITION,
    "signal"        => SIGNAL_DEFINITION,
    "exit-status"   => EXIT_STATUS_DEFINITION,
    "exit-signal"   => EXIT_SIGNAL_DEFINITION,
  },
}

Instance Attribute Summary

Attributes included from Loggable

#log_key, #logger

Method Summary

Methods included from Codable

#common_definition, #conditional_definition, #decode, #decode_recursively, #encode, #initialize

Methods included from Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn