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

Public Member Functions

 __construct ($channel, $type, $wantReply, $status)
 
 getStatus ()
 
 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

 $status
 Exit status of the process.
 
- 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-status" request type.

Definition at line 18 of file ExitStatus.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitStatus::__construct (   $channel,
  $type,
  $wantReply,
  $status 
)

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).
int$statusExit status of the process.

Definition at line 33 of file ExitStatus.php.

References fpoirotte\Pssht\Messages\CHANNEL\Base\$channel, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitStatus\$status, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$type, and fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$wantReply.

Member Function Documentation

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitStatus::getStatus ( )

Get the exit status of the process.

Return values
intExit status of the process.

Definition at line 57 of file ExitStatus.php.

References fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitStatus\$status.

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\ExitStatus::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 39 of file ExitStatus.php.


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