Skip to content

Commit 7ebcd9d

Browse files
RevenantXRevenantX
committed
update docs
1 parent 4d4399b commit 7ebcd9d

6 files changed

+129
-26
lines changed

‎docs/api/LiteNetLib.DisconnectReason.html

+4
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,10 @@ <h3 id="fields">Fields
116116
<td id="LiteNetLib_DisconnectReason_NetworkUnreachable">NetworkUnreachable</td>
117117
<td></td>
118118
</tr>
119+
<tr>
120+
<td id="LiteNetLib_DisconnectReason_Reconnect">Reconnect</td>
121+
<td></td>
122+
</tr>
119123
<tr>
120124
<td id="LiteNetLib_DisconnectReason_RemoteConnectionClose">RemoteConnectionClose</td>
121125
<td></td>

‎docs/api/LiteNetLib.NetConstants.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,12 @@ <h5 class="fieldValue">Field Value</h5>
139139
</table>
140140

141141

142-
<h4 id="LiteNetLib_NetConstants_FragmentHeaderSize" data-uid="LiteNetLib.NetConstants.FragmentHeaderSize">FragmentHeaderSize</h4>
142+
<h4 id="LiteNetLib_NetConstants_FragmentedHeaderTotalSize" data-uid="LiteNetLib.NetConstants.FragmentedHeaderTotalSize">FragmentedHeaderTotalSize</h4>
143143
<div class="markdown level1 summary"></div>
144144
<div class="markdown level1 conceptual"></div>
145145
<h5 class="decalaration">Declaration</h5>
146146
<div class="codewrapper">
147-
<pre><code class="lang-csharp hljs">public const int FragmentHeaderSize = 6</code></pre>
147+
<pre><code class="lang-csharp hljs">public const int FragmentedHeaderTotalSize = 10</code></pre>
148148
</div>
149149
<h5 class="fieldValue">Field Value</h5>
150150
<table class="table table-bordered table-striped table-condensed">
@@ -163,12 +163,12 @@ <h5 class="fieldValue">Field Value</h5>
163163
</table>
164164

165165

166-
<h4 id="LiteNetLib_NetConstants_FragmentTotalSize" data-uid="LiteNetLib.NetConstants.FragmentTotalSize">FragmentTotalSize</h4>
166+
<h4 id="LiteNetLib_NetConstants_FragmentHeaderSize" data-uid="LiteNetLib.NetConstants.FragmentHeaderSize">FragmentHeaderSize</h4>
167167
<div class="markdown level1 summary"></div>
168168
<div class="markdown level1 conceptual"></div>
169169
<h5 class="decalaration">Declaration</h5>
170170
<div class="codewrapper">
171-
<pre><code class="lang-csharp hljs">public const int FragmentTotalSize = 10</code></pre>
171+
<pre><code class="lang-csharp hljs">public const int FragmentHeaderSize = 6</code></pre>
172172
</div>
173173
<h5 class="fieldValue">Field Value</h5>
174174
<table class="table table-bordered table-striped table-condensed">

‎docs/api/LiteNetLib.NetManager.html

+25
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,31 @@ <h5 class="fieldValue">Field Value</h5>
209209
</table>
210210

211211

212+
<h4 id="LiteNetLib_NetManager_EnableStatistics" data-uid="LiteNetLib.NetManager.EnableStatistics">EnableStatistics</h4>
213+
<div class="markdown level1 summary"><p>Toggles the collection of network statistics for the instance and all known peers</p>
214+
</div>
215+
<div class="markdown level1 conceptual"></div>
216+
<h5 class="decalaration">Declaration</h5>
217+
<div class="codewrapper">
218+
<pre><code class="lang-csharp hljs">public bool EnableStatistics</code></pre>
219+
</div>
220+
<h5 class="fieldValue">Field Value</h5>
221+
<table class="table table-bordered table-striped table-condensed">
222+
<thead>
223+
<tr>
224+
<th>Type</th>
225+
<th>Description</th>
226+
</tr>
227+
</thead>
228+
<tbody>
229+
<tr>
230+
<td><span class="xref">System.Boolean</span></td>
231+
<td></td>
232+
</tr>
233+
</tbody>
234+
</table>
235+
236+
212237
<h4 id="LiteNetLib_NetManager_IPv6Enabled" data-uid="LiteNetLib.NetManager.IPv6Enabled">IPv6Enabled</h4>
213238
<div class="markdown level1 summary"><p>IPv6 support</p>
214239
</div>

‎docs/api/LiteNetLib.NetPeer.html

+51
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,57 @@ <h5 class="returns">Returns</h5>
534534
</table>
535535

536536

537+
<a id="LiteNetLib_NetPeer_GetPacketsCountInReliableQueue_" data-uid="LiteNetLib.NetPeer.GetPacketsCountInReliableQueue*"></a>
538+
<h4 id="LiteNetLib_NetPeer_GetPacketsCountInReliableQueue_System_Byte_System_Boolean_" data-uid="LiteNetLib.NetPeer.GetPacketsCountInReliableQueue(System.Byte,System.Boolean)">GetPacketsCountInReliableQueue(Byte, Boolean)</h4>
539+
<div class="markdown level1 summary"><p>Returns packets count in queue for reliable channel</p>
540+
</div>
541+
<div class="markdown level1 conceptual"></div>
542+
<h5 class="decalaration">Declaration</h5>
543+
<div class="codewrapper">
544+
<pre><code class="lang-csharp hljs">public int GetPacketsCountInReliableQueue(byte channelNumber, bool ordered)</code></pre>
545+
</div>
546+
<h5 class="parameters">Parameters</h5>
547+
<table class="table table-bordered table-striped table-condensed">
548+
<thead>
549+
<tr>
550+
<th>Type</th>
551+
<th>Name</th>
552+
<th>Description</th>
553+
</tr>
554+
</thead>
555+
<tbody>
556+
<tr>
557+
<td><span class="xref">System.Byte</span></td>
558+
<td><span class="parametername">channelNumber</span></td>
559+
<td><p>number of channel 0-63</p>
560+
</td>
561+
</tr>
562+
<tr>
563+
<td><span class="xref">System.Boolean</span></td>
564+
<td><span class="parametername">ordered</span></td>
565+
<td><p>type of channel ReliableOrdered or ReliableUnordered</p>
566+
</td>
567+
</tr>
568+
</tbody>
569+
</table>
570+
<h5 class="returns">Returns</h5>
571+
<table class="table table-bordered table-striped table-condensed">
572+
<thead>
573+
<tr>
574+
<th>Type</th>
575+
<th>Description</th>
576+
</tr>
577+
</thead>
578+
<tbody>
579+
<tr>
580+
<td><span class="xref">System.Int32</span></td>
581+
<td><p>packets count in channel queue</p>
582+
</td>
583+
</tr>
584+
</tbody>
585+
</table>
586+
587+
537588
<a id="LiteNetLib_NetPeer_Send_" data-uid="LiteNetLib.NetPeer.Send*"></a>
538589
<h4 id="LiteNetLib_NetPeer_Send_LiteNetLib_Utils_NetDataWriter_LiteNetLib_DeliveryMethod_" data-uid="LiteNetLib.NetPeer.Send(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod)">Send(NetDataWriter, DeliveryMethod)</h4>
539590
<div class="markdown level1 summary"><p>Send data to peer (channel - 0)</p>

‎docs/manifest.json

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"homepages": [],
3-
"source_base_path": "E:/Projects/LiteNetLib/docfx_project",
3+
"source_base_path": "e:/Projects/LiteNetLib/docfx_project",
44
"xrefmap": "xrefmap.yml",
55
"files": [
66
{
@@ -69,7 +69,7 @@
6969
"output": {
7070
".html": {
7171
"relative_path": "api/LiteNetLib.DisconnectReason.html",
72-
"hash": "bwiXxzvDldsUl2V2qjk6+w=="
72+
"hash": "KZu1v51wJ+p3k8siuBsACA=="
7373
}
7474
},
7575
"is_incremental": false,
@@ -237,7 +237,7 @@
237237
"output": {
238238
".html": {
239239
"relative_path": "api/LiteNetLib.NetConstants.html",
240-
"hash": "fGPFM2XaFvNUlCUHGxe6sQ=="
240+
"hash": "IIxHFuHh8rBmmM8sxxr8jQ=="
241241
}
242242
},
243243
"is_incremental": false,
@@ -285,7 +285,7 @@
285285
"output": {
286286
".html": {
287287
"relative_path": "api/LiteNetLib.NetManager.html",
288-
"hash": "2wkgtoSnum4DI4S2JdDi5g=="
288+
"hash": "HGMnfqkyhA5uY6cGkfHuRA=="
289289
}
290290
},
291291
"is_incremental": false,
@@ -309,7 +309,7 @@
309309
"output": {
310310
".html": {
311311
"relative_path": "api/LiteNetLib.NetPeer.html",
312-
"hash": "9T+30gYn5ZmiDwoy+5WbEA=="
312+
"hash": "Y8MVN7aLRlYWtmmh9Rav1A=="
313313
}
314314
},
315315
"is_incremental": false,
@@ -552,7 +552,7 @@
552552
"hash": "WZ1EOM3Cf/oichDNKx9s9Q=="
553553
}
554554
},
555-
"is_incremental": false,
555+
"is_incremental": true,
556556
"version": ""
557557
},
558558
{
@@ -576,7 +576,7 @@
576576
"hash": "H1MRW3oqFMr9r3YtBFLKMw=="
577577
}
578578
},
579-
"is_incremental": false,
579+
"is_incremental": true,
580580
"version": ""
581581
},
582582
{
@@ -600,7 +600,7 @@
600600
"hash": "dXc0cXBRoSPBAJd8n67QxQ=="
601601
}
602602
},
603-
"is_incremental": false,
603+
"is_incremental": true,
604604
"version": ""
605605
},
606606
{
@@ -619,25 +619,23 @@
619619
"incremental_info": [
620620
{
621621
"status": {
622-
"can_incremental": false,
623-
"details": "Cannot build incrementally because config changed.",
622+
"can_incremental": true,
624623
"incrementalPhase": "build",
625624
"total_file_count": 0,
626-
"skipped_file_count": 0,
627-
"full_build_reason_code": "ConfigChanged"
625+
"skipped_file_count": 0
628626
},
629627
"processors": {
630628
"ConceptualDocumentProcessor": {
631-
"can_incremental": false,
629+
"can_incremental": true,
632630
"incrementalPhase": "build",
633631
"total_file_count": 3,
634-
"skipped_file_count": 0
632+
"skipped_file_count": 3
635633
},
636634
"ManagedReferenceDocumentProcessor": {
637-
"can_incremental": false,
635+
"can_incremental": true,
638636
"incrementalPhase": "build",
639637
"total_file_count": 45,
640-
"skipped_file_count": 0
638+
"skipped_file_count": 3
641639
},
642640
"TocDocumentProcessor": {
643641
"can_incremental": false,

‎docs/xrefmap.yml

+31-6
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,12 @@ references:
303303
commentId: F:LiteNetLib.DisconnectReason.NetworkUnreachable
304304
fullName: LiteNetLib.DisconnectReason.NetworkUnreachable
305305
nameWithType: DisconnectReason.NetworkUnreachable
306+
- uid: LiteNetLib.DisconnectReason.Reconnect
307+
name: Reconnect
308+
href: api/LiteNetLib.DisconnectReason.html#LiteNetLib_DisconnectReason_Reconnect
309+
commentId: F:LiteNetLib.DisconnectReason.Reconnect
310+
fullName: LiteNetLib.DisconnectReason.Reconnect
311+
nameWithType: DisconnectReason.Reconnect
306312
- uid: LiteNetLib.DisconnectReason.RemoteConnectionClose
307313
name: RemoteConnectionClose
308314
href: api/LiteNetLib.DisconnectReason.html#LiteNetLib_DisconnectReason_RemoteConnectionClose
@@ -1176,18 +1182,18 @@ references:
11761182
commentId: F:LiteNetLib.NetConstants.DefaultWindowSize
11771183
fullName: LiteNetLib.NetConstants.DefaultWindowSize
11781184
nameWithType: NetConstants.DefaultWindowSize
1185+
- uid: LiteNetLib.NetConstants.FragmentedHeaderTotalSize
1186+
name: FragmentedHeaderTotalSize
1187+
href: api/LiteNetLib.NetConstants.html#LiteNetLib_NetConstants_FragmentedHeaderTotalSize
1188+
commentId: F:LiteNetLib.NetConstants.FragmentedHeaderTotalSize
1189+
fullName: LiteNetLib.NetConstants.FragmentedHeaderTotalSize
1190+
nameWithType: NetConstants.FragmentedHeaderTotalSize
11791191
- uid: LiteNetLib.NetConstants.FragmentHeaderSize
11801192
name: FragmentHeaderSize
11811193
href: api/LiteNetLib.NetConstants.html#LiteNetLib_NetConstants_FragmentHeaderSize
11821194
commentId: F:LiteNetLib.NetConstants.FragmentHeaderSize
11831195
fullName: LiteNetLib.NetConstants.FragmentHeaderSize
11841196
nameWithType: NetConstants.FragmentHeaderSize
1185-
- uid: LiteNetLib.NetConstants.FragmentTotalSize
1186-
name: FragmentTotalSize
1187-
href: api/LiteNetLib.NetConstants.html#LiteNetLib_NetConstants_FragmentTotalSize
1188-
commentId: F:LiteNetLib.NetConstants.FragmentTotalSize
1189-
fullName: LiteNetLib.NetConstants.FragmentTotalSize
1190-
nameWithType: NetConstants.FragmentTotalSize
11911197
- uid: LiteNetLib.NetConstants.HalfMaxSequence
11921198
name: HalfMaxSequence
11931199
href: api/LiteNetLib.NetConstants.html#LiteNetLib_NetConstants_HalfMaxSequence
@@ -1451,6 +1457,12 @@ references:
14511457
commentId: F:LiteNetLib.NetManager.DisconnectTimeout
14521458
fullName: LiteNetLib.NetManager.DisconnectTimeout
14531459
nameWithType: NetManager.DisconnectTimeout
1460+
- uid: LiteNetLib.NetManager.EnableStatistics
1461+
name: EnableStatistics
1462+
href: api/LiteNetLib.NetManager.html#LiteNetLib_NetManager_EnableStatistics
1463+
commentId: F:LiteNetLib.NetManager.EnableStatistics
1464+
fullName: LiteNetLib.NetManager.EnableStatistics
1465+
nameWithType: NetManager.EnableStatistics
14541466
- uid: LiteNetLib.NetManager.FirstPeer
14551467
name: FirstPeer
14561468
href: api/LiteNetLib.NetManager.html#LiteNetLib_NetManager_FirstPeer
@@ -2117,6 +2129,19 @@ references:
21172129
isSpec: "True"
21182130
fullName: LiteNetLib.NetPeer.GetMaxSinglePacketSize
21192131
nameWithType: NetPeer.GetMaxSinglePacketSize
2132+
- uid: LiteNetLib.NetPeer.GetPacketsCountInReliableQueue(System.Byte,System.Boolean)
2133+
name: GetPacketsCountInReliableQueue(Byte, Boolean)
2134+
href: api/LiteNetLib.NetPeer.html#LiteNetLib_NetPeer_GetPacketsCountInReliableQueue_System_Byte_System_Boolean_
2135+
commentId: M:LiteNetLib.NetPeer.GetPacketsCountInReliableQueue(System.Byte,System.Boolean)
2136+
fullName: LiteNetLib.NetPeer.GetPacketsCountInReliableQueue(System.Byte, System.Boolean)
2137+
nameWithType: NetPeer.GetPacketsCountInReliableQueue(Byte, Boolean)
2138+
- uid: LiteNetLib.NetPeer.GetPacketsCountInReliableQueue*
2139+
name: GetPacketsCountInReliableQueue
2140+
href: api/LiteNetLib.NetPeer.html#LiteNetLib_NetPeer_GetPacketsCountInReliableQueue_
2141+
commentId: Overload:LiteNetLib.NetPeer.GetPacketsCountInReliableQueue
2142+
isSpec: "True"
2143+
fullName: LiteNetLib.NetPeer.GetPacketsCountInReliableQueue
2144+
nameWithType: NetPeer.GetPacketsCountInReliableQueue
21202145
- uid: LiteNetLib.NetPeer.Id
21212146
name: Id
21222147
href: api/LiteNetLib.NetPeer.html#LiteNetLib_NetPeer_Id

0 commit comments

Comments
 (0)