Преглед на файлове

Improve documentation of LocalPacketSize.

Gert Driesen преди 8 години
родител
ревизия
fa640e12a5
променени са 2 файла, в които са добавени 18 реда и са изтрити 2 реда
  1. 9 1
      src/Renci.SshNet/Channels/Channel.cs
  2. 9 1
      src/Renci.SshNet/Channels/IChannel.cs

+ 9 - 1
src/Renci.SshNet/Channels/Channel.cs

@@ -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
src/Renci.SshNet/Channels/IChannel.cs

@@ -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>