forked from RevenantX/LiteNetLib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathLiteNetLib.xml
More file actions
737 lines (737 loc) · 33.9 KB
/
LiteNetLib.xml
File metadata and controls
737 lines (737 loc) · 33.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<?xml version="1.0"?>
<doc>
<assembly>
<name>LiteNetLib</name>
</assembly>
<members>
<member name="T:LiteNetLib.UnconnectedMessageType">
<summary>
Type of message that you receive in OnNetworkReceiveUnconnected event
</summary>
</member>
<member name="T:LiteNetLib.DisconnectReason">
<summary>
Disconnect reason that you receive in OnPeerDisconnected event
</summary>
</member>
<member name="T:LiteNetLib.DisconnectInfo">
<summary>
Additional information about disconnection
</summary>
</member>
<member name="F:LiteNetLib.DisconnectInfo.Reason">
<summary>
Additional info why peer disconnected
</summary>
</member>
<member name="F:LiteNetLib.DisconnectInfo.SocketErrorCode">
<summary>
Error code (if reason is SocketSendError or SocketReceiveError)
</summary>
</member>
<member name="F:LiteNetLib.DisconnectInfo.AdditionalData">
<summary>
Additional data that can be accessed (only if reason is RemoteConnectionClose)
</summary>
</member>
<member name="M:LiteNetLib.INetEventListener.OnPeerConnected(LiteNetLib.NetPeer)">
<summary>
New remote peer connected to host, or client connected to remote host
</summary>
<param name="peer">Connected peer object</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnPeerDisconnected(LiteNetLib.NetPeer,LiteNetLib.DisconnectInfo)">
<summary>
Peer disconnected
</summary>
<param name="peer">disconnected peer</param>
<param name="disconnectInfo">additional info about reason, errorCode or data received with disconnect message</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnNetworkError(LiteNetLib.NetEndPoint,System.Int32)">
<summary>
Network error (on send or receive)
</summary>
<param name="endPoint">From endPoint (can be null)</param>
<param name="socketErrorCode">Socket error code</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnNetworkReceive(LiteNetLib.NetPeer,LiteNetLib.Utils.NetDataReader,LiteNetLib.DeliveryMethod)">
<summary>
Received some data
</summary>
<param name="peer">From peer</param>
<param name="reader">DataReader containing all received data</param>
<param name="deliveryMethod">Type of received packet</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnNetworkReceiveUnconnected(LiteNetLib.NetEndPoint,LiteNetLib.Utils.NetDataReader,LiteNetLib.UnconnectedMessageType)">
<summary>
Received unconnected message
</summary>
<param name="remoteEndPoint">From address (IP and Port)</param>
<param name="reader">Message data</param>
<param name="messageType">Message type (simple, discovery request or responce)</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnNetworkLatencyUpdate(LiteNetLib.NetPeer,System.Int32)">
<summary>
Latency information updated
</summary>
<param name="peer">Peer with updated latency</param>
<param name="latency">latency value in milliseconds</param>
</member>
<member name="M:LiteNetLib.INetEventListener.OnConnectionRequest(LiteNetLib.ConnectionRequest)">
<summary>
On peer connection requested
</summary>
<param name="request">Request information (EndPoint, internal id, additional data)</param>
</member>
<member name="T:LiteNetLib.INetLogger">
<summary>
Interface to implement for your own logger
</summary>
</member>
<member name="T:LiteNetLib.NetDebug">
<summary>
Static class for defining your own LiteNetLib logger instead of Console.WriteLine
or Debug.Log if compiled with UNITY flag
</summary>
</member>
<member name="M:LiteNetLib.Utils.NetDataReader.Clone">
<summary>
Clone NetDataReader without data copy (usable for OnReceive)
</summary>
<returns>new NetDataReader instance</returns>
</member>
<member name="M:LiteNetLib.Utils.NetDataWriter.FromBytes(System.Byte[],System.Boolean)">
<summary>
Creates NetDataWriter from existing ByteArray
</summary>
<param name="bytes">Source byte array</param>
<param name="copy">Copy array to new location or use existing</param>
</member>
<member name="M:LiteNetLib.Utils.NetDataWriter.FromBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates NetDataWriter from existing ByteArray (always copied data)
</summary>
<param name="bytes">Source byte array</param>
<param name="offset">Offset of array</param>
<param name="length">Length of array</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1">
<summary>
Register nested property type
</summary>
<typeparam name="T">INetSerializable structure</typeparam>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1(System.Action{LiteNetLib.Utils.NetDataWriter,``0},System.Func{LiteNetLib.Utils.NetDataReader,``0})">
<summary>
Register nested property type
</summary>
<param name="writeDelegate"></param>
<param name="readDelegate"></param>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1(System.Func{``0})">
<summary>
Register nested property type
</summary>
<typeparam name="T">INetSerializable class</typeparam>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadAllPackets(LiteNetLib.Utils.NetDataReader)">
<summary>
Reads all available data from NetDataReader and calls OnReceive delegates
</summary>
<param name="reader">NetDataReader with packets data</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadAllPackets(LiteNetLib.Utils.NetDataReader,System.Object)">
<summary>
Reads all available data from NetDataReader and calls OnReceive delegates
</summary>
<param name="reader">NetDataReader with packets data</param>
<param name="userData">Argument that passed to OnReceivedEvent</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadPacket(LiteNetLib.Utils.NetDataReader)">
<summary>
Reads one packet from NetDataReader and calls OnReceive delegate
</summary>
<param name="reader">NetDataReader with packet</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadPacket(LiteNetLib.Utils.NetDataReader,System.Object)">
<summary>
Reads one packet from NetDataReader and calls OnReceive delegate
</summary>
<param name="reader">NetDataReader with packet</param>
<param name="userData">Argument that passed to OnReceivedEvent</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.Subscribe``1(System.Action{``0},System.Func{``0})">
<summary>
Register and subscribe to packet receive event
</summary>
<param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
<param name="packetConstructor">Method that constructs packet intead of slow Activator.CreateInstance</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.Subscribe``2(System.Action{``0,``1},System.Func{``0})">
<summary>
Register and subscribe to packet receive event (with userData)
</summary>
<param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
<param name="packetConstructor">Method that constructs packet intead of slow Activator.CreateInstance</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.SubscribeReusable``1(System.Action{``0})">
<summary>
Register and subscribe to packet receive event
This metod will overwrite last received packet class on receive (less garbage)
</summary>
<param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
</member>
<member name="M:LiteNetLib.Utils.NetPacketProcessor.SubscribeReusable``2(System.Action{``0,``1})">
<summary>
Register and subscribe to packet receive event
This metod will overwrite last received packet class on receive (less garbage)
</summary>
<param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1">
<summary>
Register nested property type
</summary>
<typeparam name="T">INetSerializable structure</typeparam>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1(System.Func{``0})">
<summary>
Register nested property type
</summary>
<typeparam name="T">INetSerializable class</typeparam>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1(System.Action{LiteNetLib.Utils.NetDataWriter,``0},System.Func{LiteNetLib.Utils.NetDataReader,``0})">
<summary>
Register nested property type
</summary>
<param name="writeDelegate"></param>
<param name="readDelegate"></param>
<returns>True - if register successful, false - if type already registered</returns>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.Deserialize``1(LiteNetLib.Utils.NetDataReader)">
<summary>
Reads packet with known type
</summary>
<param name="reader">NetDataReader with packet</param>
<returns>Returns packet if packet in reader is matched type</returns>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.Deserialize``1(LiteNetLib.Utils.NetDataReader,``0)">
<summary>
Reads packet with known type (non alloc variant)
</summary>
<param name="reader">NetDataReader with packet</param>
<param name="target">Deserialization target</param>
<returns>Returns true if packet in reader is matched type</returns>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.Serialize``1(LiteNetLib.Utils.NetDataWriter,``0)">
<summary>
Serialize struct to NetDataWriter (fast)
</summary>
<param name="writer">Serialization target NetDataWriter</param>
<param name="obj">Object to serialize</param>
</member>
<member name="M:LiteNetLib.Utils.NetSerializer.Serialize``1(``0)">
<summary>
Serialize struct to byte array
</summary>
<param name="obj">Object to serialize</param>
<returns>byte array with serialized data</returns>
</member>
<member name="T:LiteNetLib.NatPunchModule">
<summary>
Module for UDP NAT Hole punching operations. Can be accessed from NetManager
</summary>
</member>
<member name="T:LiteNetLib.DeliveryMethod">
<summary>
Sending method type
</summary>
</member>
<member name="F:LiteNetLib.DeliveryMethod.Unreliable">
<summary>
Unreliable. Packets can be dropped, duplicated or arrive without order
</summary>
</member>
<member name="F:LiteNetLib.DeliveryMethod.ReliableUnordered">
<summary>
Reliable. All packets will be sent and received, but without order
</summary>
</member>
<member name="F:LiteNetLib.DeliveryMethod.Sequenced">
<summary>
Unreliable. Packets can be dropped, but never duplicated and arrive in order
</summary>
</member>
<member name="F:LiteNetLib.DeliveryMethod.ReliableOrdered">
<summary>
Reliable and ordered. All packets will be sent and received in order
</summary>
</member>
<member name="T:LiteNetLib.NetConstants">
<summary>
Network constants. Can be tuned from sources for your purposes.
</summary>
</member>
<member name="T:LiteNetLib.NetEndPoint">
<summary>
Network End Point. Contains ip address and port
</summary>
</member>
<member name="T:LiteNetLib.NetManager">
<summary>
Main class for all network operations. Can be used as client and/or server.
</summary>
</member>
<member name="F:LiteNetLib.NetManager.UnconnectedMessagesEnabled">
<summary>
Enable messages receiving without connection. (with SendUnconnectedMessage method)
</summary>
</member>
<member name="F:LiteNetLib.NetManager.NatPunchEnabled">
<summary>
Enable nat punch messages
</summary>
</member>
<member name="F:LiteNetLib.NetManager.UpdateTime">
<summary>
Library logic update and send period in milliseconds
</summary>
</member>
<member name="F:LiteNetLib.NetManager.PingInterval">
<summary>
Interval for latency detection and checking connection
</summary>
</member>
<member name="F:LiteNetLib.NetManager.DisconnectTimeout">
<summary>
If NetManager doesn't receive any packet from remote peer during this time then connection will be closed
(including library internal keepalive packets)
</summary>
</member>
<member name="F:LiteNetLib.NetManager.SimulatePacketLoss">
<summary>
Simulate packet loss by dropping random amout of packets. (Works only in DEBUG mode)
</summary>
</member>
<member name="F:LiteNetLib.NetManager.SimulateLatency">
<summary>
Simulate latency by holding packets for random time. (Works only in DEBUG mode)
</summary>
</member>
<member name="F:LiteNetLib.NetManager.SimulationPacketLossChance">
<summary>
Chance of packet loss when simulation enabled. value in percents (1 - 100).
</summary>
</member>
<member name="F:LiteNetLib.NetManager.SimulationMinLatency">
<summary>
Minimum simulated latency
</summary>
</member>
<member name="F:LiteNetLib.NetManager.SimulationMaxLatency">
<summary>
Maximum simulated latency
</summary>
</member>
<member name="F:LiteNetLib.NetManager.UnsyncedEvents">
<summary>
Experimental feature. Events automatically will be called without PollEvents method from another thread
</summary>
</member>
<member name="F:LiteNetLib.NetManager.DiscoveryEnabled">
<summary>
Allows receive DiscoveryRequests
</summary>
</member>
<member name="F:LiteNetLib.NetManager.MergeEnabled">
<summary>
Merge small packets into one before sending to reduce outgoing packets count. (May increase a bit outgoing data size)
</summary>
</member>
<member name="F:LiteNetLib.NetManager.ReconnectDelay">
<summary>
Delay betwen initial connection attempts
</summary>
</member>
<member name="F:LiteNetLib.NetManager.MaxConnectAttempts">
<summary>
Maximum connection attempts before client stops and call disconnect event.
</summary>
</member>
<member name="F:LiteNetLib.NetManager.ReuseAddress">
<summary>
Enables socket option "ReuseAddress" for specific purposes
</summary>
</member>
<member name="F:LiteNetLib.NetManager.Statistics">
<summary>
Statistics of all connections
</summary>
</member>
<member name="F:LiteNetLib.NetManager.NatPunchModule">
<summary>
NatPunchModule for NAT hole punching operations
</summary>
</member>
<member name="P:LiteNetLib.NetManager.IsRunning">
<summary>
Returns true if socket listening and update thread is running
</summary>
</member>
<member name="P:LiteNetLib.NetManager.LocalPort">
<summary>
Local EndPoint (host and port)
</summary>
</member>
<member name="M:LiteNetLib.NetManager.#ctor(LiteNetLib.INetEventListener)">
<summary>
NetManager constructor with maxConnections = 1 (usable for client)
</summary>
<param name="listener">Network events listener</param>
</member>
<member name="M:LiteNetLib.NetManager.#ctor(LiteNetLib.INetEventListener,System.Int32)">
<summary>
NetManager constructor
</summary>
<param name="listener">Network events listener</param>
<param name="maxConnections">Maximum connections (incoming and outcoming)</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod)">
<summary>
Send data to all connected peers
</summary>
<param name="writer">DataWriter with data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],LiteNetLib.DeliveryMethod)">
<summary>
Send data to all connected peers
</summary>
<param name="data">Data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod)">
<summary>
Send data to all connected peers
</summary>
<param name="data">Data</param>
<param name="start">Start of data</param>
<param name="length">Length of data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
<summary>
Send data to all connected peers
</summary>
<param name="writer">DataWriter with data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
<param name="excludePeer">Excluded peer</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
<summary>
Send data to all connected peers
</summary>
<param name="data">Data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
<param name="excludePeer">Excluded peer</param>
</member>
<member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
<summary>
Send data to all connected peers
</summary>
<param name="data">Data</param>
<param name="start">Start of data</param>
<param name="length">Length of data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
<param name="excludePeer">Excluded peer</param>
</member>
<member name="M:LiteNetLib.NetManager.Start">
<summary>
Start logic thread and listening on available port
</summary>
</member>
<member name="M:LiteNetLib.NetManager.Start(System.String,System.String,System.Int32)">
<summary>
Start logic thread and listening on selected port
</summary>
<param name="addressIPv4">bind to specific ipv4 address</param>
<param name="addressIPv6">bind to specific ipv6 address</param>
<param name="port">port to listen</param>
</member>
<member name="M:LiteNetLib.NetManager.Start(System.Int32)">
<summary>
Start logic thread and listening on selected port
</summary>
<param name="port">port to listen</param>
</member>
<member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(System.Byte[],LiteNetLib.NetEndPoint)">
<summary>
Send message without connection
</summary>
<param name="message">Raw data</param>
<param name="remoteEndPoint">Packet destination</param>
<returns>Operation result</returns>
</member>
<member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(LiteNetLib.Utils.NetDataWriter,LiteNetLib.NetEndPoint)">
<summary>
Send message without connection
</summary>
<param name="writer">Data serializer</param>
<param name="remoteEndPoint">Packet destination</param>
<returns>Operation result</returns>
</member>
<member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(System.Byte[],System.Int32,System.Int32,LiteNetLib.NetEndPoint)">
<summary>
Send message without connection
</summary>
<param name="message">Raw data</param>
<param name="start">data start</param>
<param name="length">data length</param>
<param name="remoteEndPoint">Packet destination</param>
<returns>Operation result</returns>
</member>
<member name="M:LiteNetLib.NetManager.Flush">
<summary>
Flush all queued packets of all peers
</summary>
</member>
<member name="M:LiteNetLib.NetManager.PollEvents">
<summary>
Receive all pending events. Call this in game update code
</summary>
</member>
<member name="M:LiteNetLib.NetManager.Connect(System.String,System.Int32,System.String)">
<summary>
Connect to remote host
</summary>
<param name="address">Server IP or hostname</param>
<param name="port">Server Port</param>
<param name="key">Connection key</param>
<returns>Null if connections limit reached, New NetPeer if new connection, Old NetPeer if already connected</returns>
</member>
<member name="M:LiteNetLib.NetManager.Connect(System.String,System.Int32,LiteNetLib.Utils.NetDataWriter)">
<summary>
Connect to remote host
</summary>
<param name="address">Server IP or hostname</param>
<param name="port">Server Port</param>
<param name="connectionData">Additional data for remote peer</param>
<returns>Null if connections limit reached, New NetPeer if new connection, Old NetPeer if already connected</returns>
</member>
<member name="M:LiteNetLib.NetManager.Connect(LiteNetLib.NetEndPoint,System.String)">
<summary>
Connect to remote host
</summary>
<param name="target">Server end point (ip and port)</param>
<param name="key">Connection key</param>
<returns>Null if connections limit reached, New NetPeer if new connection, Old NetPeer if already connected</returns>
</member>
<member name="M:LiteNetLib.NetManager.Connect(LiteNetLib.NetEndPoint,LiteNetLib.Utils.NetDataWriter)">
<summary>
Connect to remote host
</summary>
<param name="target">Server end point (ip and port)</param>
<param name="connectionData">Additional data for remote peer</param>
<returns>Null if connections limit reached, New NetPeer if new connection, Old NetPeer if already connected</returns>
</member>
<member name="M:LiteNetLib.NetManager.Stop">
<summary>
Force closes connection and stop all threads.
</summary>
</member>
<member name="M:LiteNetLib.NetManager.GetFirstPeer">
<summary>
Get first peer. Usefull for Client mode
</summary>
<returns></returns>
</member>
<member name="M:LiteNetLib.NetManager.GetPeers">
<summary>
Get copy of current connected peers (slow! use GetPeersNonAlloc for best performance)
</summary>
<returns>Array with connected peers</returns>
</member>
<member name="M:LiteNetLib.NetManager.GetPeers(LiteNetLib.ConnectionState)">
<summary>
Get copy of current connected peers (slow! use GetPeersNonAlloc for best performance)
</summary>
<returns>Array with connected peers</returns>
</member>
<member name="M:LiteNetLib.NetManager.GetPeersNonAlloc(System.Collections.Generic.List{LiteNetLib.NetPeer},LiteNetLib.ConnectionState)">
<summary>
Get copy of peers (without allocations)
</summary>
<param name="peers">List that will contain result</param>
<param name="peerState">State of peers</param>
</member>
<member name="M:LiteNetLib.NetManager.DisconnectPeerForce(LiteNetLib.NetPeer)">
<summary>
Immediately disconnect peer from server without additional data
</summary>
<param name="peer">peer to disconnect</param>
</member>
<member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer)">
<summary>
Disconnect peer from server
</summary>
<param name="peer">peer to disconnect</param>
</member>
<member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,System.Byte[])">
<summary>
Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
</summary>
<param name="peer">peer to disconnect</param>
<param name="data">additional data</param>
</member>
<member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,LiteNetLib.Utils.NetDataWriter)">
<summary>
Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
</summary>
<param name="peer">peer to disconnect</param>
<param name="writer">additional data</param>
</member>
<member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,System.Byte[],System.Int32,System.Int32)">
<summary>
Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
</summary>
<param name="peer">peer to disconnect</param>
<param name="data">additional data</param>
<param name="start">data start</param>
<param name="count">data length</param>
</member>
<member name="T:LiteNetLib.ConnectionState">
<summary>
Peer connection state
</summary>
</member>
<member name="T:LiteNetLib.NetPeer">
<summary>
Network peer. Main purpose is sending messages to specific peer.
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.ConnectionState">
<summary>
Current connection state
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.ConnectId">
<summary>
Connection id for internal purposes, but can be used as key in your dictionary of peers
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.EndPoint">
<summary>
Peer ip address and port
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.Ping">
<summary>
Current ping in milliseconds
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.Mtu">
<summary>
Current MTU - Maximum Transfer Unit ( maximum udp packet size without fragmentation )
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.TimeSinceLastPacket">
<summary>
Time since last packet received (including internal library packets)
</summary>
</member>
<member name="P:LiteNetLib.NetPeer.NetManager">
<summary>
Peer parent NetManager
</summary>
</member>
<member name="F:LiteNetLib.NetPeer.Tag">
<summary>
Application defined object containing data about the connection
</summary>
</member>
<member name="F:LiteNetLib.NetPeer.Statistics">
<summary>
Statistics of peer connection
</summary>
</member>
<member name="M:LiteNetLib.NetPeer.GetMaxSinglePacketSize(LiteNetLib.DeliveryMethod)">
<summary>
Gets maximum size of packet that will be not fragmented.
</summary>
<param name="options">Type of packet that you want send</param>
<returns>size in bytes</returns>
</member>
<member name="M:LiteNetLib.NetPeer.Send(System.Byte[],LiteNetLib.DeliveryMethod)">
<summary>
Send data to peer
</summary>
<param name="data">Data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetPeer.Send(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod)">
<summary>
Send data to peer
</summary>
<param name="dataWriter">DataWriter with data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetPeer.Send(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod)">
<summary>
Send data to peer
</summary>
<param name="data">Data</param>
<param name="start">Start of data</param>
<param name="length">Length of data</param>
<param name="options">Send options (reliable, unreliable, etc.)</param>
</member>
<member name="M:LiteNetLib.NetPeer.Flush">
<summary>
Flush all queued packets
</summary>
</member>
<member name="T:LiteNetLib.LocalAddrType">
<summary>
Address type that you want to receive from NetUtils.GetLocalIp method
</summary>
</member>
<member name="T:LiteNetLib.NetUtils">
<summary>
Some specific network utilities
</summary>
</member>
<member name="M:LiteNetLib.NetUtils.RequestTimeFromNTP(System.String,System.Int32,System.Action{System.Nullable{System.DateTime}})">
<summary>
Request time from NTP server and calls callback (if success)
</summary>
<param name="ntpServerAddress">NTP Server address</param>
<param name="port">port</param>
<param name="onRequestComplete">callback (called from other thread!)</param>
</member>
<member name="M:LiteNetLib.NetUtils.GetLocalIpList(LiteNetLib.LocalAddrType)">
<summary>
Get all local ip addresses
</summary>
<param name="addrType">type of address (IPv4, IPv6 or both)</param>
<returns>List with all local ip adresses</returns>
</member>
<member name="M:LiteNetLib.NetUtils.GetLocalIpList(System.Collections.Generic.List{System.String},LiteNetLib.LocalAddrType)">
<summary>
Get all local ip addresses (non alloc version)
</summary>
<param name="targetList">result list</param>
<param name="addrType">type of address (IPv4, IPv6 or both)</param>
</member>
<member name="M:LiteNetLib.NetUtils.GetLocalIp(LiteNetLib.LocalAddrType)">
<summary>
Get first detected local ip address
</summary>
<param name="addrType">type of address (IPv4, IPv6 or both)</param>
<returns>IP address if available. Else - string.Empty</returns>
</member>
</members>
</doc>