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

Public Member Functions

 __construct ($channel, $type, $wantReply, $term, $widthInCols, $heightInRows, $widthInPixels, $heightInPixels, $modes)
 
 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

 $heightInPixels
 Terminal height in pixels.
 
 $heightInRows
 Terminal height in rows.
 
 $modes
 Encoded terminal modes.
 
 $term
 Terminal to emulate.
 
 $widthInCols
 Terminal width in characters.
 
 $widthInPixels
 Terminal width in pixels.
 
- 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 "pty-req" request type.

Definition at line 18 of file PtyReq.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq::__construct (   $channel,
  $type,
  $wantReply,
  $term,
  $widthInCols,
  $heightInRows,
  $widthInPixels,
  $heightInPixels,
  $modes 
)

Construct a new "pty-req" SSH_MSG_CHANNEL_REQUEST message.

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$termTerminal to emulate.
int$widthInColsTerminal width in characters.
int$heightInRowsTerminal height in rows.
int$widthInPixelsTerminal width in pixels.
int$heightInPixelsTerminal height in pixels.
string$modesEncoded terminal modes.

Definition at line 62 of file PtyReq.php.

References fpoirotte\Pssht\Messages\CHANNEL\Base\$channel, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$heightInPixels, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$heightInRows, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$modes, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$term, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$type, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$wantReply, fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$widthInCols, and fpoirotte\Pssht\Messages\CHANNEL\REQUEST\PtyReq\$widthInPixels.

Member Function Documentation

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


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