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

Public Member Functions

 __construct ($reasonCode=0, $reasonMessage= '', $language= '')
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Public Member Functions

static getMessageId ()
 
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Public Attributes

const SSH_DISCONNECT_AUTH_CANCELLED_BY_USER = 13
 Disconnected due to authentication cancelation.
 
const SSH_DISCONNECT_BY_APPLICATION = 11
 Disconnected by the application layer.
 
const SSH_DISCONNECT_COMPRESSION_ERROR = 6
 Disconnected due to a compression error.
 
const SSH_DISCONNECT_CONNECTION_LOST = 10
 Disconnected due to connection loss.
 
const SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE = 9
 Disconnected due to an unverifiable host key.
 
const SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT = 1
 Disconnected because the remote host is not allowed to connect.
 
const SSH_DISCONNECT_ILLEGAL_USER_NAME = 15
 Disconnected due to an illegal user name.
 
const SSH_DISCONNECT_KEY_EXCHANGE_FAILED = 3
 Disconnected due to key exchange failure.
 
const SSH_DISCONNECT_MAC_ERROR = 5
 Disconnected due to a Message Authentication Code error.
 
const SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE = 14
 Disconnected because no more authentication methods are available.
 
const SSH_DISCONNECT_PROTOCOL_ERROR = 2
 Disconnected due to a protocol error.
 
const SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED = 8
 Disconnected due to an unsupported protocol version being requested.
 
const SSH_DISCONNECT_RESERVED = 4
 Disconnected due to a reserved error.
 
const SSH_DISCONNECT_SERVICE_NOT_AVAILABLE = 7
 Disconnected because the requested service is not available.
 
const SSH_DISCONNECT_TOO_MANY_CONNECTIONS = 12
 Disconnected because too many connections are currently opened.
 

Protected Attributes

 $code
 Disconnection reason.
 
 $language
 Language the disconnection message is written into (from RFC 3066).
 
 $message
 Disconnection message (human-readable description in UTF-8 encoding).
 

Detailed Description

SSH_MSG_DISCONNECT message (RFC 4253).

Definition at line 17 of file DISCONNECT.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\DISCONNECT::__construct (   $reasonCode = 0,
  $reasonMessage = '',
  $language = '' 
)

Construct a new disconnection message.

Parameters
int$reasonCodeDisconnection code.
string$reasonMessageDisconnection message, as a human-readable description in ISO-10646 UTF-8 encoding.
string$languageLanguage tag the disconnection message is written into, in RFC 3066 format.

Definition at line 89 of file DISCONNECT.php.

References fpoirotte\Pssht\Messages\DISCONNECT\$language.

Member Function Documentation

static fpoirotte\Pssht\Messages\DISCONNECT::getMessageId ( )
static

Retrieve the message's identifier.

Return values
intMessage identifier.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 108 of file DISCONNECT.php.

fpoirotte\Pssht\Messages\DISCONNECT::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 113 of file DISCONNECT.php.

static fpoirotte\Pssht\Messages\DISCONNECT::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 121 of file DISCONNECT.php.

Referenced by fpoirotte\Pssht\Handlers\DISCONNECT\handle().


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