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

Public Member Functions

 __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 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)
 

Static Protected Member Functions

static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Protected Attributes

 $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.
 

Detailed Description

Abstract SSH_MSG_CHANNEL_REQUEST message (RFC 4254).

Definition at line 17 of file Base.php.

Constructor & Destructor Documentation

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

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).

Definition at line 36 of file Base.php.

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

Member Function Documentation

static fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::getMessageId ( )
static

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 51 of file Base.php.

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::getType ( )

Get message type.

Return values
stringMessage type.

Definition at line 105 of file Base.php.

References fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$type.

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::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 Base.php.

static fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::unserialize ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
staticfinal

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 85 of file Base.php.

static fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::unserializeSub ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
staticprotected

Unserialize the sub-message.

Parameters
fpoirotte::Pssht::Wire::Decoder$decoderDecoder to use during unserialization.
Return values
arrayArray of unserialized data forming the sub-message.
Note
This method MUST be redefined by subclasses. The default implementation simply throws an exception.

(PHPMD.UnusedFormalParameter)

Definition at line 80 of file Base.php.

fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base::wantsReply ( )

Flag indicating whether the sender expects a reply.

Return values
booltrue if the sender wants a reply, false otherwise.

Definition at line 117 of file Base.php.

References fpoirotte\Pssht\Messages\CHANNEL\REQUEST\Base\$wantReply.


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