pssht  latest
SSH server library written in PHP
fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal Class Reference
+ Inheritance diagram for fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal:

Public Member Functions

 __construct ($channel, $type, $wantReply, $signal, $coreDumped, $error, $language)
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 
- Public Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base
 __construct ($channel, $type, $wantReply)
 
 getType ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 
 wantsReply ()
 
- Public Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
 __construct ($channel)
 
 getChannel ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Protected Member Functions

static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 
- Static Protected Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base
static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Protected Attributes

 $coreDumped
 Whether a core file was dumped or not.
 
 $error
 Textual explanation of the error.
 
 $language
 Language the error message in written into, in RFC 3066 format.
 
 $signal
 Name of the signal that caused the process to exit.
 
- Protected Attributes inherited from fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base
 $type
 Message type.
 
 $wantReply
 Whether the sender of the message wants a reply or not.
 
- Protected Attributes inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
 $channel
 Local channel identifier.
 

Additional Inherited Members

- Static Public Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base
static getMessageId ()
 
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 
- Static Public Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Detailed Description

SSH_MSG_CHANNEL_REQUEST message (RFC 4254) for the "exit-signal" request type.

Definition at line 18 of file ExitSignal.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal::__construct (   $channel,
  $type,
  $wantReply,
  $signal,
  $coreDumped,
  $error,
  $language 
)

Construct a new SSH_MSG_CHANNEL_REQUEST message for the "exit-signal" type.

Abstract constructor for a channel-related SSH message.

Parameters
int$channelLocal channel identifier.
string$typeMessage type.
bool$wantReplyIndicates whether the sender of this message wants a reply (true) or not (false).
string$signalSignal name, without the "SIG" prefix.
bool$coreDumpedWhether a core file was dumped (true) or not (false).
string$errorText explaining the error in more details.
string$languageLanguage the error message is written into, in RFC 3066 format.

Definition at line 53 of file ExitSignal.php.

References fpoirotte\Pssht\Messages\CHANNEL\Base\$channel, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal\$coreDumped, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal\$error, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal\$language, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal\$signal, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$type, and fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$wantReply.

Member Function Documentation

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitSignal::serialize ( \fpoirotte\Pssht\Wire\Encoder  $encoder)

Serialize the message.

Parameters
fpoirotte::Pssht::Wire::Encoder$encoderEncoder to use to perform serialization.
Return values
MessageInterfaceReturns this message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 62 of file ExitSignal.php.


The documentation for this class was generated from the following file: