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

Public Member Functions

 __construct ($type, $channel, $initialWindowSize, $maximumPacketSize)
 
 getType ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 
- Public Member Functions inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
 __construct ($channel)
 
 getChannel ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Public Member Functions

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)
 

Protected Attributes

 $initialWindowSize
 Initial window size for the channel.
 
 $maximumPacketSize
 Maximum packet size.
 
 $type
 Channel type.
 
- Protected Attributes inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
 $channel
 Local channel identifier.
 

Detailed Description

SSH_MSG_CHANNEL_OPEN message (RFC 4254).

Definition at line 17 of file OPEN.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\CHANNEL\OPEN::__construct (   $type,
  $channel,
  $initialWindowSize,
  $maximumPacketSize 
)

Construct a new SSH_MSG_CHANNEL_OPEN message.

Parameters
string$typeChannel type to open.

Abstract constructor for a channel-related SSH message.

Parameters
int$channelLocal channel identifier.
int$initialWindowSizeInitial window size for the channel.
int$maximumPacketSizeMaximum packet size.

Definition at line 43 of file OPEN.php.

References fpoirotte\Pssht\Messages\CHANNEL\Base\$channel, fpoirotte\Pssht\Messages\CHANNEL\OPEN\$initialWindowSize, fpoirotte\Pssht\Messages\CHANNEL\OPEN\$maximumPacketSize, and fpoirotte\Pssht\Messages\CHANNEL\OPEN\$type.

Member Function Documentation

static fpoirotte\Pssht\Messages\CHANNEL\OPEN::getMessageId ( )
static

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 51 of file OPEN.php.

fpoirotte\Pssht\Messages\CHANNEL\OPEN::getType ( )

Get the channel type to open.

Return values
stringChannel type to open.

Definition at line 81 of file OPEN.php.

References fpoirotte\Pssht\Messages\CHANNEL\OPEN\$type.

fpoirotte\Pssht\Messages\CHANNEL\OPEN::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 56 of file OPEN.php.

static fpoirotte\Pssht\Messages\CHANNEL\OPEN::unserialize ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
static

Unserialize some data into a message.

Parameters
fpoirotte::Pssht::Wire::Decoder$decoderDecoder to use to perform unserialization.
Return values
MessageInterfaceUnserialized message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 65 of file OPEN.php.

Referenced by fpoirotte\Pssht\Handlers\CHANNEL\OPEN\handle().


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