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

Public Member Functions

 __construct ($channel, $reasonCode, $reasonMessage, $language= '')
 
 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)
 

Public Attributes

const SSH_OPEN_ADMINISTRATIVELY_PROHIBITED = 1
 The requested action was administratively prohibited.
 
const SSH_OPEN_CONNECT_FAILED = 2
 The connection failed.
 
const SSH_OPEN_RESOURCE_SHORTAGE = 4
 The requested action was aborted due to a resource shortage.
 
const SSH_OPEN_UNKNOWN_CHANNEL_TYPE = 3
 The requested channel type is unsupported.
 

Protected Attributes

 $language
 Language the message is written into, in RFC 3066 format.
 
 $reasonCode
 Reason for the failure (as a code).
 
 $reasonMessage
 Reason for the failure (as a human-readable description).
 
- Protected Attributes inherited from fpoirotte\Pssht\Messages\CHANNEL\Base
 $channel
 Local channel identifier.
 

Detailed Description

SSH_MSG_CHANNEL_OPEN_FAILURE message (RFC 4254).

Definition at line 17 of file FAILURE.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\CHANNEL\OPEN\FAILURE::__construct (   $channel,
  $reasonCode,
  $reasonMessage,
  $language = '' 
)

Construct a new SSH_MSG_CHANNEL_OPEN_FAILURE message.

Abstract constructor for a channel-related SSH message.

Parameters
int$channelLocal channel identifier.
int$reasonCodeReason for the failure, as a code.
string$reasonMessageReason for the failure, as a human-readable description in RFC 3066 format.
string$language(optional) Language the message in written into, in RFC 3066 format. If omitted, the description is assumed to be language-neutral.

Definition at line 59 of file FAILURE.php.

References fpoirotte\Pssht\Messages\CHANNEL\Base\$channel, fpoirotte\Pssht\Messages\CHANNEL\OPEN\FAILURE\$language, fpoirotte\Pssht\Messages\CHANNEL\OPEN\FAILURE\$reasonCode, and fpoirotte\Pssht\Messages\CHANNEL\OPEN\FAILURE\$reasonMessage.

Member Function Documentation

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

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 67 of file FAILURE.php.

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

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


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