docs: Update

atc-net · Feb 15, 2024 · d21e56d · d21e56d
1 parent f102eb1
commit d21e56d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 4 deletions.
diff --git a/docs/CodeDoc/Atc.Network/Atc.Network.Tcp.md b/docs/CodeDoc/Atc.Network/Atc.Network.Tcp.md
@@ -499,7 +499,12 @@ This class contains default constant for `Atc.Network.Tcp.TcpClient` and `Atc.Ne
 >```csharp
 >int DefaultSendReceiveTimeout
 >```
-><b>Summary:</b> The send/receive time-out value, in milliseconds.
+><b>Summary:</b> The send/receive time-out value, in milliseconds (5 min.).
+#### GracePeriodTimeout
+>```csharp
+>int GracePeriodTimeout
+>```
+><b>Summary:</b> The grace period timeout, in milliseconds (1 sec).
 
 <br />
 

diff --git a/docs/CodeDoc/Atc.Network/Atc.Network.Udp.md b/docs/CodeDoc/Atc.Network/Atc.Network.Udp.md
@@ -365,11 +365,21 @@ This class contains default constant for `Atc.Network.Udp.UdpClient` and `Atc.Ne
 >int DefaultBufferSize
 >```
 ><b>Summary:</b> The send/receive buffer value, in bytes. The default is 8192 (8 Kb);
+#### DefaultConnectTimeout
+>```csharp
+>int DefaultConnectTimeout
+>```
+><b>Summary:</b> The connect time-out value, in milliseconds (10 sec).
 #### DefaultSendReceiveTimeout
 >```csharp
 >int DefaultSendReceiveTimeout
 >```
-><b>Summary:</b> The send/receive time-out value, in milliseconds.
+><b>Summary:</b> The send/receive time-out value, in milliseconds (5 min.).
+#### GracePeriodTimeout
+>```csharp
+>int GracePeriodTimeout
+>```
+><b>Summary:</b> The grace period timeout, in milliseconds (1 sec).
 
 <br />
 

diff --git a/docs/CodeDoc/Atc.Network/Atc.Network.md b/docs/CodeDoc/Atc.Network/Atc.Network.md
@@ -283,7 +283,7 @@ Enumeration: NetworkQualityCategoryType.
 >&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`tcpClient`&nbsp;&nbsp;-&nbsp;&nbsp;The TCP client.<br />
 #### SetBufferSizeAndTimeouts
 >```csharp
->void SetBufferSizeAndTimeouts(this TcpClient tcpClient, int sendTimeout = 0, int sendBufferSize = 8192, int receiveTimeout = 0, int receiveBufferSize = 8192)
+>void SetBufferSizeAndTimeouts(this TcpClient tcpClient, int sendTimeout = 600000, int sendBufferSize = 8192, int receiveTimeout = 600000, int receiveBufferSize = 8192)
 >```
 ><b>Summary:</b> Sets the buffer size and timeouts.
 >

diff --git a/docs/CodeDoc/Atc.Network/IndexExtended.md b/docs/CodeDoc/Atc.Network/IndexExtended.md
@@ -38,7 +38,7 @@
 - [TcpClientExtensions](Atc.Network.md#tcpclientextensions)
   -  Static Methods
      - DisableKeepAlive(this TcpClient tcpClient)
-     - SetBufferSizeAndTimeouts(this TcpClient tcpClient, int sendTimeout = 0, int sendBufferSize = 8192, int receiveTimeout = 0, int receiveBufferSize = 8192)
+     - SetBufferSizeAndTimeouts(this TcpClient tcpClient, int sendTimeout = 600000, int sendBufferSize = 8192, int receiveTimeout = 600000, int receiveBufferSize = 8192)
      - SetKeepAlive(this TcpClient tcpClient, int tcpKeepAliveTime = 2, int tcpKeepAliveInterval = 2, int tcpKeepAliveRetryCount = 5)
 - [TerminationType](Atc.Network.md#terminationtype)
 - [TransportProtocolType](Atc.Network.md#transportprotocoltype)
@@ -335,6 +335,7 @@
      - int DefaultReconnectRetryInterval
      - int DefaultReconnectRetryMaxAttempts
      - int DefaultSendReceiveTimeout
+     - int GracePeriodTimeout
 - [TcpServer](Atc.Network.Tcp.md#tcpserver)
   -  Properties
      - IpAddress
@@ -412,7 +413,9 @@
 - [UdpConstants](Atc.Network.Udp.md#udpconstants)
   -  Static Fields
      - int DefaultBufferSize
+     - int DefaultConnectTimeout
      - int DefaultSendReceiveTimeout
+     - int GracePeriodTimeout
 - [UdpServer](Atc.Network.Udp.md#udpserver)
   -  Properties
      - IsRunning