Improve documentation of LocalPacketSize.

This commit is contained in:
Gert Driesen
2017-07-23 20:41:54 +02:00
parent 46966d37cb
commit fa640e12a5
2 changed files with 18 additions and 2 deletions
+9 -1
View File
@@ -120,11 +120,19 @@ namespace Renci.SshNet.Channels
public uint LocalChannelNumber { get; private set; }
/// <summary>
/// Gets the maximum size of a packet.
/// Gets the maximum size of a data packet that we can receive using the channel.
/// </summary>
/// <value>
/// The maximum size of a packet.
/// </value>
/// <remarks>
/// <para>
/// This is the maximum size (in bytes) we support for the data (payload) of a
/// <c>SSH_MSG_CHANNEL_DATA</c> message we receive.
/// </para>
/// <para>
/// We currently do not enforce this limit.
/// </para>
public uint LocalPacketSize { get; private set; }
/// <summary>
+9 -1
View File
@@ -43,11 +43,19 @@ namespace Renci.SshNet.Channels
uint LocalChannelNumber { get; }
/// <summary>
/// Gets the maximum size of a packet.
/// Gets the maximum size of a data packet that we can receive using the channel.
/// </summary>
/// <value>
/// The maximum size of a packet.
/// </value>
/// <remarks>
/// <para>
/// This is the maximum size (in bytes) we support for the data (payload) of a
/// <c>SSH_MSG_CHANNEL_DATA</c> message we receive.
/// </para>
/// <para>
/// We currently do not enforce this limit.
/// </para>
uint LocalPacketSize { get; }
/// <summary>