pssht  latest
SSH server library written in PHP
fpoirotte\Pssht\Wire\Encoder Class Reference

Public Member Functions

 __construct (\fpoirotte\Pssht\Buffer $buffer=null)
 
 encodeBoolean ($value)
 
 encodeBytes ($value)
 
 encodeMpint ($value)
 
 encodeNameList (array $values)
 
 encodeString ($value)
 
 encodeUint32 ($value)
 
 encodeUint64 ($value)
 
 getBuffer ()
 

Protected Attributes

 $buffer
 Buffer where the encoded values will be appended.
 

Detailed Description

SSH-encode values (RFC 4251).

Definition at line 17 of file Encoder.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Wire\Encoder::__construct ( \fpoirotte\Pssht\Buffer  $buffer = null)

Construct a new encoder.

Parameters
fpoirotte::Pssht::Buffer$buffer(optional) Buffer to write to. If omitted, a new empty buffer is used.

Definition at line 29 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\$buffer.

Member Function Documentation

fpoirotte\Pssht\Wire\Encoder::encodeBoolean (   $value)

Encode a boolean ("boolean" type).

Parameters
string$valueBoolean value to encode.
Return values
EncoderReturns this encoder.

Definition at line 73 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeBytes().

fpoirotte\Pssht\Wire\Encoder::encodeBytes (   $value)

Encode raw bytes ("byte" type).

Parameters
string$valueRaw array of bytes.
Return values
EncoderReturns this encoder.

Definition at line 58 of file Encoder.php.

Referenced by fpoirotte\Pssht\Wire\Encoder\encodeBoolean(), fpoirotte\Pssht\Wire\Encoder\encodeString(), fpoirotte\Pssht\Wire\Encoder\encodeUint32(), and fpoirotte\Pssht\Wire\Encoder\encodeUint64().

fpoirotte\Pssht\Wire\Encoder::encodeMpint (   $value)

Encode an arbitrary precision number ("mpint" type).

Parameters
resource$valueGMP resource representing the arbitrary precision number to encode.
Return values
EncoderReturns this encoder.

Definition at line 134 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeString().

fpoirotte\Pssht\Wire\Encoder::encodeNameList ( array  $values)

Encode a list of names ("name-list" type).

Parameters
array$valuesA list of algorithm names.
Return values
EncoderReturns this encoder.

Definition at line 159 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeString(), and fpoirotte\Pssht\Wire\Encoder\encodeUint32().

fpoirotte\Pssht\Wire\Encoder::encodeString (   $value)

Encode a string ("string" type).

Parameters
string$valueCharacter string to encode.
Return values
EncoderReturns this encoder.

Definition at line 118 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeBytes(), and fpoirotte\Pssht\Wire\Encoder\encodeUint32().

Referenced by fpoirotte\Pssht\Wire\Encoder\encodeMpint(), and fpoirotte\Pssht\Wire\Encoder\encodeNameList().

fpoirotte\Pssht\Wire\Encoder::encodeUint32 (   $value)

Encode a 32 bits unsigned value ("uint32" type).

Parameters
string$value32 bits unsigned value to encode.
Return values
EncoderReturns this encoder.

Definition at line 87 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeBytes().

Referenced by fpoirotte\Pssht\Wire\Encoder\encodeNameList(), and fpoirotte\Pssht\Wire\Encoder\encodeString().

fpoirotte\Pssht\Wire\Encoder::encodeUint64 (   $value)

Encode a 64 bits unsigned value ("uint64" type).

Parameters
resource$valueGMP resource representing the 64 bits unsigned value to encode.
Return values
EncoderReturns this encoder.

Definition at line 102 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\encodeBytes().

fpoirotte\Pssht\Wire\Encoder::getBuffer ( )

Get the buffer associated with this encoder.

Return values
fpoirotte::Pssht::BufferThe buffer associated with this encoder.

Definition at line 44 of file Encoder.php.

References fpoirotte\Pssht\Wire\Encoder\$buffer.


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