LiteNetLib.xml 55 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>LiteNetLib</name>
  5. </assembly>
  6. <members>
  7. <member name="M:LiteNetLib.ConnectionRequest.Accept">
  8. <summary>
  9. Accept connection and get new NetPeer as result
  10. </summary>
  11. <returns>Connected NetPeer</returns>
  12. </member>
  13. <member name="T:LiteNetLib.UnconnectedMessageType">
  14. <summary>
  15. Type of message that you receive in OnNetworkReceiveUnconnected event
  16. </summary>
  17. </member>
  18. <member name="T:LiteNetLib.DisconnectReason">
  19. <summary>
  20. Disconnect reason that you receive in OnPeerDisconnected event
  21. </summary>
  22. </member>
  23. <member name="T:LiteNetLib.DisconnectInfo">
  24. <summary>
  25. Additional information about disconnection
  26. </summary>
  27. </member>
  28. <member name="F:LiteNetLib.DisconnectInfo.Reason">
  29. <summary>
  30. Additional info why peer disconnected
  31. </summary>
  32. </member>
  33. <member name="F:LiteNetLib.DisconnectInfo.SocketErrorCode">
  34. <summary>
  35. Error code (if reason is SocketSendError or SocketReceiveError)
  36. </summary>
  37. </member>
  38. <member name="F:LiteNetLib.DisconnectInfo.AdditionalData">
  39. <summary>
  40. Additional data that can be accessed (only if reason is RemoteConnectionClose)
  41. </summary>
  42. </member>
  43. <member name="M:LiteNetLib.INetEventListener.OnPeerConnected(LiteNetLib.NetPeer)">
  44. <summary>
  45. New remote peer connected to host, or client connected to remote host
  46. </summary>
  47. <param name="peer">Connected peer object</param>
  48. </member>
  49. <member name="M:LiteNetLib.INetEventListener.OnPeerDisconnected(LiteNetLib.NetPeer,LiteNetLib.DisconnectInfo)">
  50. <summary>
  51. Peer disconnected
  52. </summary>
  53. <param name="peer">disconnected peer</param>
  54. <param name="disconnectInfo">additional info about reason, errorCode or data received with disconnect message</param>
  55. </member>
  56. <member name="M:LiteNetLib.INetEventListener.OnNetworkError(System.Net.IPEndPoint,System.Net.Sockets.SocketError)">
  57. <summary>
  58. Network error (on send or receive)
  59. </summary>
  60. <param name="endPoint">From endPoint (can be null)</param>
  61. <param name="socketError">Socket error</param>
  62. </member>
  63. <member name="M:LiteNetLib.INetEventListener.OnNetworkReceive(LiteNetLib.NetPeer,LiteNetLib.NetPacketReader,LiteNetLib.DeliveryMethod)">
  64. <summary>
  65. Received some data
  66. </summary>
  67. <param name="peer">From peer</param>
  68. <param name="reader">DataReader containing all received data</param>
  69. <param name="deliveryMethod">Type of received packet</param>
  70. </member>
  71. <member name="M:LiteNetLib.INetEventListener.OnNetworkReceiveUnconnected(System.Net.IPEndPoint,LiteNetLib.NetPacketReader,LiteNetLib.UnconnectedMessageType)">
  72. <summary>
  73. Received unconnected message
  74. </summary>
  75. <param name="remoteEndPoint">From address (IP and Port)</param>
  76. <param name="reader">Message data</param>
  77. <param name="messageType">Message type (simple, discovery request or responce)</param>
  78. </member>
  79. <member name="M:LiteNetLib.INetEventListener.OnNetworkLatencyUpdate(LiteNetLib.NetPeer,System.Int32)">
  80. <summary>
  81. Latency information updated
  82. </summary>
  83. <param name="peer">Peer with updated latency</param>
  84. <param name="latency">latency value in milliseconds</param>
  85. </member>
  86. <member name="M:LiteNetLib.INetEventListener.OnConnectionRequest(LiteNetLib.ConnectionRequest)">
  87. <summary>
  88. On peer connection requested
  89. </summary>
  90. <param name="request">Request information (EndPoint, internal id, additional data)</param>
  91. </member>
  92. <member name="T:LiteNetLib.INetLogger">
  93. <summary>
  94. Interface to implement for your own logger
  95. </summary>
  96. </member>
  97. <member name="T:LiteNetLib.NetDebug">
  98. <summary>
  99. Static class for defining your own LiteNetLib logger instead of Console.WriteLine
  100. or Debug.Log if compiled with UNITY flag
  101. </summary>
  102. </member>
  103. <member name="T:LiteNetLib.Ntp.NtpPacket">
  104. <summary>
  105. Represents RFC4330 SNTP packet used for communication to and from a network time server.
  106. </summary>
  107. <remarks>
  108. <para>
  109. Most applications should just use the <see cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" /> property.
  110. </para>
  111. <para>
  112. The same data structure represents both request and reply packets.
  113. Request and reply differ in which properties are set and to what values.
  114. </para>
  115. <para>
  116. The only real property is <see cref="P:LiteNetLib.Ntp.NtpPacket.Bytes" />.
  117. All other properties read from and write to the underlying byte array
  118. with the exception of <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />,
  119. which is not part of the packet on network and it is instead set locally after receiving the packet.
  120. </para>
  121. <para>
  122. Copied from <a href="https://guerrillantp.machinezoo.com/">GuerrillaNtp project</a>
  123. with permission from Robert Vazan (@robertvazan) under MIT license, see https://github.com/RevenantX/LiteNetLib/pull/236
  124. </para>
  125. </remarks>
  126. </member>
  127. <member name="P:LiteNetLib.Ntp.NtpPacket.Bytes">
  128. <summary>
  129. Gets RFC4330-encoded SNTP packet.
  130. </summary>
  131. <value>
  132. Byte array containing RFC4330-encoded SNTP packet. It is at least 48 bytes long.
  133. </value>
  134. <remarks>
  135. This is the only real property. All other properties except
  136. <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" /> read from or write to this byte array.
  137. </remarks>
  138. </member>
  139. <member name="P:LiteNetLib.Ntp.NtpPacket.LeapIndicator">
  140. <summary>
  141. Gets the leap second indicator.
  142. </summary>
  143. <value>
  144. Leap second warning, if any. Special value
  145. <see cref="F:LiteNetLib.Ntp.NtpLeapIndicator.AlarmCondition" /> indicates unsynchronized server clock.
  146. Default is <see cref="F:LiteNetLib.Ntp.NtpLeapIndicator.NoWarning" />.
  147. </value>
  148. <remarks>
  149. Only servers fill in this property. Clients can consult this property for possible leap second warning.
  150. </remarks>
  151. </member>
  152. <member name="P:LiteNetLib.Ntp.NtpPacket.VersionNumber">
  153. <summary>
  154. Gets or sets protocol version number.
  155. </summary>
  156. <value>
  157. SNTP protocol version. Default is 4, which is the latest version at the time of this writing.
  158. </value>
  159. <remarks>
  160. In request packets, clients should leave this property at default value 4.
  161. Servers usually reply with the same protocol version.
  162. </remarks>
  163. </member>
  164. <member name="P:LiteNetLib.Ntp.NtpPacket.Mode">
  165. <summary>
  166. Gets or sets SNTP packet mode, i.e. whether this is client or server packet.
  167. </summary>
  168. <value>
  169. SNTP packet mode. Default is <see cref="F:LiteNetLib.Ntp.NtpMode.Client" /> in newly created packets.
  170. Server reply should have this property set to <see cref="F:LiteNetLib.Ntp.NtpMode.Server" />.
  171. </value>
  172. </member>
  173. <member name="P:LiteNetLib.Ntp.NtpPacket.Stratum">
  174. <summary>
  175. Gets server's distance from the reference clock.
  176. </summary>
  177. <value>
  178. <para>
  179. Distance from the reference clock. This property is set only in server reply packets.
  180. Servers connected directly to reference clock hardware set this property to 1.
  181. Statum number is incremented by 1 on every hop down the NTP server hierarchy.
  182. </para>
  183. <para>
  184. Special value 0 indicates that this packet is a Kiss-o'-Death message
  185. with kiss code stored in <see cref="P:LiteNetLib.Ntp.NtpPacket.ReferenceId" />.
  186. </para>
  187. </value>
  188. </member>
  189. <member name="P:LiteNetLib.Ntp.NtpPacket.Poll">
  190. <summary>
  191. Gets server's preferred polling interval.
  192. </summary>
  193. <value>
  194. Polling interval in log2 seconds, e.g. 4 stands for 16s and 17 means 131,072s.
  195. </value>
  196. </member>
  197. <member name="P:LiteNetLib.Ntp.NtpPacket.Precision">
  198. <summary>
  199. Gets the precision of server clock.
  200. </summary>
  201. <value>
  202. Clock precision in log2 seconds, e.g. -20 for microsecond precision.
  203. </value>
  204. </member>
  205. <member name="P:LiteNetLib.Ntp.NtpPacket.RootDelay">
  206. <summary>
  207. Gets the total round-trip delay from the server to the reference clock.
  208. </summary>
  209. <value>
  210. Round-trip delay to the reference clock. Normally a positive value smaller than one second.
  211. </value>
  212. </member>
  213. <member name="P:LiteNetLib.Ntp.NtpPacket.RootDispersion">
  214. <summary>
  215. Gets the estimated error in time reported by the server.
  216. </summary>
  217. <value>
  218. Estimated error in time reported by the server. Normally a positive value smaller than one second.
  219. </value>
  220. </member>
  221. <member name="P:LiteNetLib.Ntp.NtpPacket.ReferenceId">
  222. <summary>
  223. Gets the ID of the time source used by the server or Kiss-o'-Death code sent by the server.
  224. </summary>
  225. <value>
  226. <para>
  227. ID of server's time source or Kiss-o'-Death code.
  228. Purpose of this property depends on value of <see cref="P:LiteNetLib.Ntp.NtpPacket.Stratum" /> property.
  229. </para>
  230. <para>
  231. Stratum 1 servers write here one of several special values that describe the kind of hardware clock they use.
  232. </para>
  233. <para>
  234. Stratum 2 and lower servers set this property to IPv4 address of their upstream server.
  235. If upstream server has IPv6 address, the address is hashed, because it doesn't fit in this property.
  236. </para>
  237. <para>
  238. When server sets <see cref="P:LiteNetLib.Ntp.NtpPacket.Stratum" /> to special value 0,
  239. this property contains so called kiss code that instructs the client to stop querying the server.
  240. </para>
  241. </value>
  242. </member>
  243. <member name="P:LiteNetLib.Ntp.NtpPacket.ReferenceTimestamp">
  244. <summary>
  245. Gets or sets the time when the server clock was last set or corrected.
  246. </summary>
  247. <value>
  248. Time when the server clock was last set or corrected or <c>null</c> when not specified.
  249. </value>
  250. <remarks>
  251. This Property is usually set only by servers. It usually lags server's current time by several minutes,
  252. so don't use this property for time synchronization.
  253. </remarks>
  254. </member>
  255. <member name="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp">
  256. <summary>
  257. Gets or sets the time when the client sent its request.
  258. </summary>
  259. <value>
  260. This property is <c>null</c> in request packets.
  261. In reply packets, it is the time when the client sent its request.
  262. Servers copy this value from <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />
  263. that they find in received request packet.
  264. </value>
  265. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
  266. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
  267. </member>
  268. <member name="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp">
  269. <summary>
  270. Gets or sets the time when the request was received by the server.
  271. </summary>
  272. <value>
  273. This property is <c>null</c> in request packets.
  274. In reply packets, it is the time when the server received client request.
  275. </value>
  276. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
  277. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
  278. </member>
  279. <member name="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp">
  280. <summary>
  281. Gets or sets the time when the packet was sent.
  282. </summary>
  283. <value>
  284. Time when the packet was sent. It should never be <c>null</c>.
  285. Default value is <see cref="P:System.DateTime.UtcNow" />.
  286. </value>
  287. <remarks>
  288. This property must be set by both clients and servers.
  289. </remarks>
  290. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
  291. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
  292. </member>
  293. <member name="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp">
  294. <summary>
  295. Gets or sets the time of reception of response SNTP packet on the client.
  296. </summary>
  297. <value>
  298. Time of reception of response SNTP packet on the client. It is <c>null</c> in request packets.
  299. </value>
  300. <remarks>
  301. This property is not part of the protocol and has to be set when reply packet is received.
  302. </remarks>
  303. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
  304. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
  305. </member>
  306. <member name="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime">
  307. <summary>
  308. Gets the round-trip time to the server.
  309. </summary>
  310. <value>
  311. Time the request spent travelling to the server plus the time the reply spent travelling back.
  312. This is calculated from timestamps in the packet as <c>(t1 - t0) + (t3 - t2)</c>
  313. where t0 is <see cref="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp" />,
  314. t1 is <see cref="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp" />,
  315. t2 is <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />,
  316. and t3 is <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />.
  317. This property throws an exception in request packets.
  318. </value>
  319. </member>
  320. <member name="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset">
  321. <summary>
  322. Gets the offset that should be added to local time to synchronize it with server time.
  323. </summary>
  324. <value>
  325. Time difference between server and client. It should be added to local time to get server time.
  326. It is calculated from timestamps in the packet as <c>0.5 * ((t1 - t0) - (t3 - t2))</c>
  327. where t0 is <see cref="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp" />,
  328. t1 is <see cref="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp" />,
  329. t2 is <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />,
  330. and t3 is <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />.
  331. This property throws an exception in request packets.
  332. </value>
  333. </member>
  334. <member name="M:LiteNetLib.Ntp.NtpPacket.#ctor">
  335. <summary>
  336. Initializes default request packet.
  337. </summary>
  338. <remarks>
  339. Properties <see cref="P:LiteNetLib.Ntp.NtpPacket.Mode" /> and <see cref="P:LiteNetLib.Ntp.NtpPacket.VersionNumber" />
  340. are set appropriately for request packet. Property <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />
  341. is set to <see cref="P:System.DateTime.UtcNow" />.
  342. </remarks>
  343. </member>
  344. <member name="M:LiteNetLib.Ntp.NtpPacket.#ctor(System.Byte[])">
  345. <summary>
  346. Initializes packet from received data.
  347. </summary>
  348. </member>
  349. <member name="M:LiteNetLib.Ntp.NtpPacket.FromServerResponse(System.Byte[],System.DateTime)">
  350. <summary>
  351. Initializes packet from data received from a server.
  352. </summary>
  353. <param name="bytes">Data received from the server.</param>
  354. <param name="destinationTimestamp">Utc time of reception of response SNTP packet on the client.</param>
  355. <returns></returns>
  356. </member>
  357. <member name="T:LiteNetLib.Ntp.NtpLeapIndicator">
  358. <summary>
  359. Represents leap second warning from the server that instructs the client to add or remove leap second.
  360. </summary>
  361. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.LeapIndicator" />
  362. </member>
  363. <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.NoWarning">
  364. <summary>
  365. No leap second warning. No action required.
  366. </summary>
  367. </member>
  368. <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.LastMinuteHas61Seconds">
  369. <summary>
  370. Warns the client that the last minute of the current day has 61 seconds.
  371. </summary>
  372. </member>
  373. <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.LastMinuteHas59Seconds">
  374. <summary>
  375. Warns the client that the last minute of the current day has 59 seconds.
  376. </summary>
  377. </member>
  378. <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.AlarmCondition">
  379. <summary>
  380. Special value indicating that the server clock is unsynchronized and the returned time is unreliable.
  381. </summary>
  382. </member>
  383. <member name="T:LiteNetLib.Ntp.NtpMode">
  384. <summary>
  385. Describes SNTP packet mode, i.e. client or server.
  386. </summary>
  387. <seealso cref="P:LiteNetLib.Ntp.NtpPacket.Mode" />
  388. </member>
  389. <member name="F:LiteNetLib.Ntp.NtpMode.Client">
  390. <summary>
  391. Identifies client-to-server SNTP packet.
  392. </summary>
  393. </member>
  394. <member name="F:LiteNetLib.Ntp.NtpMode.Server">
  395. <summary>
  396. Identifies server-to-client SNTP packet.
  397. </summary>
  398. </member>
  399. <member name="T:LiteNetLib.Ntp.NtpRequest">
  400. <summary>
  401. Make NTP request.
  402. <para>
  403. 1. Create the object by <see cref="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})"/> method.
  404. </para>
  405. <para>
  406. 2. Use <see cref="M:LiteNetLib.Ntp.NtpRequest.Send"/> method to send requests. 3. Call <see cref="M:LiteNetLib.Ntp.NtpRequest.Close"/> to release the socket
  407. AFTER you have received the response or some timeout. If you close the socket too early, you may miss the response.
  408. </para>
  409. <para>
  410. 3. Call <see cref="M:LiteNetLib.Ntp.NtpRequest.Close"/> to release the socket AFTER you have received the response or some timeout.
  411. If you close the socket too early, you may miss the response.
  412. </para>
  413. </summary>
  414. </member>
  415. <member name="M:LiteNetLib.Ntp.NtpRequest.#ctor(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})">
  416. <summary>
  417. Initialize object, open socket.
  418. </summary>
  419. <param name="onRequestComplete">callback (called from other thread!)</param>
  420. </member>
  421. <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})">
  422. <summary>
  423. Create the requests for NTP server, open socket.
  424. </summary>
  425. <param name="endPoint">NTP Server address.</param>
  426. <param name="onRequestComplete">callback (called from other thread!)</param>
  427. </member>
  428. <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPAddress,System.Action{LiteNetLib.Ntp.NtpPacket})">
  429. <summary>
  430. Create the requests for NTP server (default port), open socket.
  431. </summary>
  432. <param name="ipAddress">NTP Server address.</param>
  433. <param name="onRequestComplete">callback (called from other thread!)</param>
  434. </member>
  435. <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.String,System.Int32,System.Action{LiteNetLib.Ntp.NtpPacket})">
  436. <summary>
  437. Create the requests for NTP server, open socket.
  438. </summary>
  439. <param name="ntpServerAddress">NTP Server address.</param>
  440. <param name="port">port</param>
  441. <param name="onRequestComplete">callback (called from other thread!)</param>
  442. </member>
  443. <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.String,System.Action{LiteNetLib.Ntp.NtpPacket})">
  444. <summary>
  445. Create the requests for NTP server (default port), open socket.
  446. </summary>
  447. <param name="ntpServerAddress">NTP Server address.</param>
  448. <param name="onRequestComplete">callback (called from other thread!)</param>
  449. </member>
  450. <member name="M:LiteNetLib.Ntp.NtpRequest.Send">
  451. <summary>
  452. Send request to the NTP server calls callback (if success).
  453. In case of error the callbacke is called with null param.
  454. </summary>
  455. </member>
  456. <member name="M:LiteNetLib.Ntp.NtpRequest.Close">
  457. <summary>
  458. Close socket.
  459. </summary>
  460. </member>
  461. <member name="M:LiteNetLib.Ntp.NtpRequest.LiteNetLib#INetSocketListener#OnMessageReceived(System.Byte[],System.Int32,System.Net.Sockets.SocketError,System.Net.IPEndPoint)">
  462. <summary>
  463. Handle received data: transform bytes to NtpPacket, close socket and call the callback.
  464. </summary>
  465. </member>
  466. <member name="M:LiteNetLib.Utils.NetDataWriter.FromBytes(System.Byte[],System.Boolean)">
  467. <summary>
  468. Creates NetDataWriter from existing ByteArray
  469. </summary>
  470. <param name="bytes">Source byte array</param>
  471. <param name="copy">Copy array to new location or use existing</param>
  472. </member>
  473. <member name="M:LiteNetLib.Utils.NetDataWriter.FromBytes(System.Byte[],System.Int32,System.Int32)">
  474. <summary>
  475. Creates NetDataWriter from existing ByteArray (always copied data)
  476. </summary>
  477. <param name="bytes">Source byte array</param>
  478. <param name="offset">Offset of array</param>
  479. <param name="length">Length of array</param>
  480. </member>
  481. <member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1">
  482. <summary>
  483. Register nested property type
  484. </summary>
  485. <typeparam name="T">INetSerializable structure</typeparam>
  486. <returns>True - if register successful, false - if type already registered</returns>
  487. </member>
  488. <member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1(System.Action{LiteNetLib.Utils.NetDataWriter,``0},System.Func{LiteNetLib.Utils.NetDataReader,``0})">
  489. <summary>
  490. Register nested property type
  491. </summary>
  492. <param name="writeDelegate"></param>
  493. <param name="readDelegate"></param>
  494. <returns>True - if register successful, false - if type already registered</returns>
  495. </member>
  496. <member name="M:LiteNetLib.Utils.NetPacketProcessor.RegisterNestedType``1(System.Func{``0})">
  497. <summary>
  498. Register nested property type
  499. </summary>
  500. <typeparam name="T">INetSerializable class</typeparam>
  501. <returns>True - if register successful, false - if type already registered</returns>
  502. </member>
  503. <member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadAllPackets(LiteNetLib.Utils.NetDataReader)">
  504. <summary>
  505. Reads all available data from NetDataReader and calls OnReceive delegates
  506. </summary>
  507. <param name="reader">NetDataReader with packets data</param>
  508. </member>
  509. <member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadAllPackets(LiteNetLib.Utils.NetDataReader,System.Object)">
  510. <summary>
  511. Reads all available data from NetDataReader and calls OnReceive delegates
  512. </summary>
  513. <param name="reader">NetDataReader with packets data</param>
  514. <param name="userData">Argument that passed to OnReceivedEvent</param>
  515. <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
  516. </member>
  517. <member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadPacket(LiteNetLib.Utils.NetDataReader)">
  518. <summary>
  519. Reads one packet from NetDataReader and calls OnReceive delegate
  520. </summary>
  521. <param name="reader">NetDataReader with packet</param>
  522. <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
  523. </member>
  524. <member name="M:LiteNetLib.Utils.NetPacketProcessor.ReadPacket(LiteNetLib.Utils.NetDataReader,System.Object)">
  525. <summary>
  526. Reads one packet from NetDataReader and calls OnReceive delegate
  527. </summary>
  528. <param name="reader">NetDataReader with packet</param>
  529. <param name="userData">Argument that passed to OnReceivedEvent</param>
  530. <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
  531. </member>
  532. <member name="M:LiteNetLib.Utils.NetPacketProcessor.Subscribe``1(System.Action{``0},System.Func{``0})">
  533. <summary>
  534. Register and subscribe to packet receive event
  535. </summary>
  536. <param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
  537. <param name="packetConstructor">Method that constructs packet intead of slow Activator.CreateInstance</param>
  538. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  539. </member>
  540. <member name="M:LiteNetLib.Utils.NetPacketProcessor.Subscribe``2(System.Action{``0,``1},System.Func{``0})">
  541. <summary>
  542. Register and subscribe to packet receive event (with userData)
  543. </summary>
  544. <param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
  545. <param name="packetConstructor">Method that constructs packet intead of slow Activator.CreateInstance</param>
  546. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  547. </member>
  548. <member name="M:LiteNetLib.Utils.NetPacketProcessor.SubscribeReusable``1(System.Action{``0})">
  549. <summary>
  550. Register and subscribe to packet receive event
  551. This metod will overwrite last received packet class on receive (less garbage)
  552. </summary>
  553. <param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
  554. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  555. </member>
  556. <member name="M:LiteNetLib.Utils.NetPacketProcessor.SubscribeReusable``2(System.Action{``0,``1})">
  557. <summary>
  558. Register and subscribe to packet receive event
  559. This metod will overwrite last received packet class on receive (less garbage)
  560. </summary>
  561. <param name="onReceive">event that will be called when packet deserialized with ReadPacket method</param>
  562. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  563. </member>
  564. <member name="M:LiteNetLib.Utils.NetPacketProcessor.RemoveSubscription``1">
  565. <summary>
  566. Remove any subscriptions by type
  567. </summary>
  568. <typeparam name="T">Packet type</typeparam>
  569. <returns>true if remove is success</returns>
  570. </member>
  571. <member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1">
  572. <summary>
  573. Register nested property type
  574. </summary>
  575. <typeparam name="T">INetSerializable structure</typeparam>
  576. <returns>True - if register successful, false - if type already registered</returns>
  577. </member>
  578. <member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1(System.Func{``0})">
  579. <summary>
  580. Register nested property type
  581. </summary>
  582. <typeparam name="T">INetSerializable class</typeparam>
  583. <returns>True - if register successful, false - if type already registered</returns>
  584. </member>
  585. <member name="M:LiteNetLib.Utils.NetSerializer.RegisterNestedType``1(System.Action{LiteNetLib.Utils.NetDataWriter,``0},System.Func{LiteNetLib.Utils.NetDataReader,``0})">
  586. <summary>
  587. Register nested property type
  588. </summary>
  589. <param name="writeDelegate"></param>
  590. <param name="readDelegate"></param>
  591. <returns>True - if register successful, false - if type already registered</returns>
  592. </member>
  593. <member name="M:LiteNetLib.Utils.NetSerializer.Register``1">
  594. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  595. </member>
  596. <member name="M:LiteNetLib.Utils.NetSerializer.Deserialize``1(LiteNetLib.Utils.NetDataReader)">
  597. <summary>
  598. Reads packet with known type
  599. </summary>
  600. <param name="reader">NetDataReader with packet</param>
  601. <returns>Returns packet if packet in reader is matched type</returns>
  602. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  603. </member>
  604. <member name="M:LiteNetLib.Utils.NetSerializer.Deserialize``1(LiteNetLib.Utils.NetDataReader,``0)">
  605. <summary>
  606. Reads packet with known type (non alloc variant)
  607. </summary>
  608. <param name="reader">NetDataReader with packet</param>
  609. <param name="target">Deserialization target</param>
  610. <returns>Returns true if packet in reader is matched type</returns>
  611. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  612. </member>
  613. <member name="M:LiteNetLib.Utils.NetSerializer.Serialize``1(LiteNetLib.Utils.NetDataWriter,``0)">
  614. <summary>
  615. Serialize struct to NetDataWriter (fast)
  616. </summary>
  617. <param name="writer">Serialization target NetDataWriter</param>
  618. <param name="obj">Object to serialize</param>
  619. <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
  620. </member>
  621. <member name="M:LiteNetLib.Utils.NetSerializer.Serialize``1(``0)">
  622. <summary>
  623. Serialize struct to byte array
  624. </summary>
  625. <param name="obj">Object to serialize</param>
  626. <returns>byte array with serialized data</returns>
  627. </member>
  628. <member name="T:LiteNetLib.NatPunchModule">
  629. <summary>
  630. Module for UDP NAT Hole punching operations. Can be accessed from NetManager
  631. </summary>
  632. </member>
  633. <member name="T:LiteNetLib.DeliveryMethod">
  634. <summary>
  635. Sending method type
  636. </summary>
  637. </member>
  638. <member name="F:LiteNetLib.DeliveryMethod.Unreliable">
  639. <summary>
  640. Unreliable. Packets can be dropped, duplicated or arrive without order
  641. </summary>
  642. </member>
  643. <member name="F:LiteNetLib.DeliveryMethod.ReliableUnordered">
  644. <summary>
  645. Reliable. All packets will be sent and received, but without order
  646. </summary>
  647. </member>
  648. <member name="F:LiteNetLib.DeliveryMethod.Sequenced">
  649. <summary>
  650. Unreliable. Packets can be dropped, but never duplicated and arrive in order
  651. </summary>
  652. </member>
  653. <member name="F:LiteNetLib.DeliveryMethod.ReliableOrdered">
  654. <summary>
  655. Reliable and ordered. All packets will be sent and received in order
  656. </summary>
  657. </member>
  658. <member name="F:LiteNetLib.DeliveryMethod.ReliableSequenced">
  659. <summary>
  660. Reliable only last packet
  661. </summary>
  662. </member>
  663. <member name="T:LiteNetLib.NetConstants">
  664. <summary>
  665. Network constants. Can be tuned from sources for your purposes.
  666. </summary>
  667. </member>
  668. <member name="T:LiteNetLib.NetManager">
  669. <summary>
  670. Main class for all network operations. Can be used as client and/or server.
  671. </summary>
  672. </member>
  673. <member name="F:LiteNetLib.NetManager.UnconnectedMessagesEnabled">
  674. <summary>
  675. Enable messages receiving without connection. (with SendUnconnectedMessage method)
  676. </summary>
  677. </member>
  678. <member name="F:LiteNetLib.NetManager.NatPunchEnabled">
  679. <summary>
  680. Enable nat punch messages
  681. </summary>
  682. </member>
  683. <member name="F:LiteNetLib.NetManager.UpdateTime">
  684. <summary>
  685. Library logic update and send period in milliseconds
  686. </summary>
  687. </member>
  688. <member name="F:LiteNetLib.NetManager.PingInterval">
  689. <summary>
  690. Interval for latency detection and checking connection
  691. </summary>
  692. </member>
  693. <member name="F:LiteNetLib.NetManager.DisconnectTimeout">
  694. <summary>
  695. If NetManager doesn't receive any packet from remote peer during this time then connection will be closed
  696. (including library internal keepalive packets)
  697. </summary>
  698. </member>
  699. <member name="F:LiteNetLib.NetManager.SimulatePacketLoss">
  700. <summary>
  701. Simulate packet loss by dropping random amout of packets. (Works only in DEBUG mode)
  702. </summary>
  703. </member>
  704. <member name="F:LiteNetLib.NetManager.SimulateLatency">
  705. <summary>
  706. Simulate latency by holding packets for random time. (Works only in DEBUG mode)
  707. </summary>
  708. </member>
  709. <member name="F:LiteNetLib.NetManager.SimulationPacketLossChance">
  710. <summary>
  711. Chance of packet loss when simulation enabled. value in percents (1 - 100).
  712. </summary>
  713. </member>
  714. <member name="F:LiteNetLib.NetManager.SimulationMinLatency">
  715. <summary>
  716. Minimum simulated latency
  717. </summary>
  718. </member>
  719. <member name="F:LiteNetLib.NetManager.SimulationMaxLatency">
  720. <summary>
  721. Maximum simulated latency
  722. </summary>
  723. </member>
  724. <member name="F:LiteNetLib.NetManager.UnsyncedEvents">
  725. <summary>
  726. Experimental feature. Events automatically will be called without PollEvents method from another thread
  727. </summary>
  728. </member>
  729. <member name="F:LiteNetLib.NetManager.DiscoveryEnabled">
  730. <summary>
  731. Allows receive DiscoveryRequests
  732. </summary>
  733. </member>
  734. <member name="F:LiteNetLib.NetManager.ReconnectDelay">
  735. <summary>
  736. Delay betwen initial connection attempts
  737. </summary>
  738. </member>
  739. <member name="F:LiteNetLib.NetManager.MaxConnectAttempts">
  740. <summary>
  741. Maximum connection attempts before client stops and call disconnect event.
  742. </summary>
  743. </member>
  744. <member name="F:LiteNetLib.NetManager.ReuseAddress">
  745. <summary>
  746. Enables socket option "ReuseAddress" for specific purposes
  747. </summary>
  748. </member>
  749. <member name="F:LiteNetLib.NetManager.Statistics">
  750. <summary>
  751. Statistics of all connections
  752. </summary>
  753. </member>
  754. <member name="F:LiteNetLib.NetManager.NatPunchModule">
  755. <summary>
  756. NatPunchModule for NAT hole punching operations
  757. </summary>
  758. </member>
  759. <member name="P:LiteNetLib.NetManager.IsRunning">
  760. <summary>
  761. Returns true if socket listening and update thread is running
  762. </summary>
  763. </member>
  764. <member name="P:LiteNetLib.NetManager.LocalPort">
  765. <summary>
  766. Local EndPoint (host and port)
  767. </summary>
  768. </member>
  769. <member name="F:LiteNetLib.NetManager.AutoRecycle">
  770. <summary>
  771. Automatically recycle NetPacketReader after OnReceive event
  772. </summary>
  773. </member>
  774. <member name="P:LiteNetLib.NetManager.FirstPeer">
  775. <summary>
  776. First peer. Useful for Client mode
  777. </summary>
  778. <returns></returns>
  779. </member>
  780. <member name="P:LiteNetLib.NetManager.PeersCount">
  781. <summary>
  782. Returns connected peers count
  783. </summary>
  784. </member>
  785. <member name="M:LiteNetLib.NetManager.#ctor(LiteNetLib.INetEventListener)">
  786. <summary>
  787. NetManager constructor
  788. </summary>
  789. <param name="listener">Network events listener</param>
  790. </member>
  791. <member name="M:LiteNetLib.NetManager.SendToAll(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod)">
  792. <summary>
  793. Send data to all connected peers
  794. </summary>
  795. <param name="writer">DataWriter with data</param>
  796. <param name="options">Send options (reliable, unreliable, etc.)</param>
  797. </member>
  798. <member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],LiteNetLib.DeliveryMethod)">
  799. <summary>
  800. Send data to all connected peers
  801. </summary>
  802. <param name="data">Data</param>
  803. <param name="options">Send options (reliable, unreliable, etc.)</param>
  804. </member>
  805. <member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod)">
  806. <summary>
  807. Send data to all connected peers
  808. </summary>
  809. <param name="data">Data</param>
  810. <param name="start">Start of data</param>
  811. <param name="length">Length of data</param>
  812. <param name="options">Send options (reliable, unreliable, etc.)</param>
  813. </member>
  814. <member name="M:LiteNetLib.NetManager.SendToAll(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
  815. <summary>
  816. Send data to all connected peers
  817. </summary>
  818. <param name="writer">DataWriter with data</param>
  819. <param name="options">Send options (reliable, unreliable, etc.)</param>
  820. <param name="excludePeer">Excluded peer</param>
  821. </member>
  822. <member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
  823. <summary>
  824. Send data to all connected peers
  825. </summary>
  826. <param name="data">Data</param>
  827. <param name="options">Send options (reliable, unreliable, etc.)</param>
  828. <param name="excludePeer">Excluded peer</param>
  829. </member>
  830. <member name="M:LiteNetLib.NetManager.SendToAll(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod,LiteNetLib.NetPeer)">
  831. <summary>
  832. Send data to all connected peers
  833. </summary>
  834. <param name="data">Data</param>
  835. <param name="start">Start of data</param>
  836. <param name="length">Length of data</param>
  837. <param name="options">Send options (reliable, unreliable, etc.)</param>
  838. <param name="excludePeer">Excluded peer</param>
  839. </member>
  840. <member name="M:LiteNetLib.NetManager.Start">
  841. <summary>
  842. Start logic thread and listening on available port
  843. </summary>
  844. </member>
  845. <member name="M:LiteNetLib.NetManager.Start(System.Net.IPAddress,System.Net.IPAddress,System.Int32)">
  846. <summary>
  847. Start logic thread and listening on selected port
  848. </summary>
  849. <param name="addressIPv4">bind to specific ipv4 address</param>
  850. <param name="addressIPv6">bind to specific ipv6 address</param>
  851. <param name="port">port to listen</param>
  852. </member>
  853. <member name="M:LiteNetLib.NetManager.Start(System.String,System.String,System.Int32)">
  854. <summary>
  855. Start logic thread and listening on selected port
  856. </summary>
  857. <param name="addressIPv4">bind to specific ipv4 address</param>
  858. <param name="addressIPv6">bind to specific ipv6 address</param>
  859. <param name="port">port to listen</param>
  860. </member>
  861. <member name="M:LiteNetLib.NetManager.Start(System.Int32)">
  862. <summary>
  863. Start logic thread and listening on selected port
  864. </summary>
  865. <param name="port">port to listen</param>
  866. </member>
  867. <member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(System.Byte[],System.Net.IPEndPoint)">
  868. <summary>
  869. Send message without connection
  870. </summary>
  871. <param name="message">Raw data</param>
  872. <param name="remoteEndPoint">Packet destination</param>
  873. <returns>Operation result</returns>
  874. </member>
  875. <member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(LiteNetLib.Utils.NetDataWriter,System.Net.IPEndPoint)">
  876. <summary>
  877. Send message without connection
  878. </summary>
  879. <param name="writer">Data serializer</param>
  880. <param name="remoteEndPoint">Packet destination</param>
  881. <returns>Operation result</returns>
  882. </member>
  883. <member name="M:LiteNetLib.NetManager.SendUnconnectedMessage(System.Byte[],System.Int32,System.Int32,System.Net.IPEndPoint)">
  884. <summary>
  885. Send message without connection
  886. </summary>
  887. <param name="message">Raw data</param>
  888. <param name="start">data start</param>
  889. <param name="length">data length</param>
  890. <param name="remoteEndPoint">Packet destination</param>
  891. <returns>Operation result</returns>
  892. </member>
  893. <member name="M:LiteNetLib.NetManager.Flush">
  894. <summary>
  895. Flush all queued packets of all peers
  896. </summary>
  897. </member>
  898. <member name="M:LiteNetLib.NetManager.PollEvents">
  899. <summary>
  900. Receive all pending events. Call this in game update code
  901. </summary>
  902. </member>
  903. <member name="M:LiteNetLib.NetManager.Connect(System.String,System.Int32,System.String)">
  904. <summary>
  905. Connect to remote host
  906. </summary>
  907. <param name="address">Server IP or hostname</param>
  908. <param name="port">Server Port</param>
  909. <param name="key">Connection key</param>
  910. <returns>New NetPeer if new connection, Old NetPeer if already connected</returns>
  911. <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
  912. </member>
  913. <member name="M:LiteNetLib.NetManager.Connect(System.String,System.Int32,LiteNetLib.Utils.NetDataWriter)">
  914. <summary>
  915. Connect to remote host
  916. </summary>
  917. <param name="address">Server IP or hostname</param>
  918. <param name="port">Server Port</param>
  919. <param name="connectionData">Additional data for remote peer</param>
  920. <returns>New NetPeer if new connection, Old NetPeer if already connected</returns>
  921. <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
  922. </member>
  923. <member name="M:LiteNetLib.NetManager.Connect(System.Net.IPEndPoint,System.String)">
  924. <summary>
  925. Connect to remote host
  926. </summary>
  927. <param name="target">Server end point (ip and port)</param>
  928. <param name="key">Connection key</param>
  929. <returns>New NetPeer if new connection, Old NetPeer if already connected</returns>
  930. <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
  931. </member>
  932. <member name="M:LiteNetLib.NetManager.Connect(System.Net.IPEndPoint,LiteNetLib.Utils.NetDataWriter)">
  933. <summary>
  934. Connect to remote host
  935. </summary>
  936. <param name="target">Server end point (ip and port)</param>
  937. <param name="connectionData">Additional data for remote peer</param>
  938. <returns>New NetPeer if new connection, Old NetPeer if already connected</returns>
  939. <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
  940. </member>
  941. <member name="M:LiteNetLib.NetManager.Stop">
  942. <summary>
  943. Force closes connection and stop all threads.
  944. </summary>
  945. </member>
  946. <member name="M:LiteNetLib.NetManager.Stop(System.Boolean)">
  947. <summary>
  948. Force closes connection and stop all threads.
  949. </summary>
  950. <param name="sendDisconnectMessages">Send disconnect messages</param>
  951. </member>
  952. <member name="M:LiteNetLib.NetManager.GetPeers">
  953. <summary>
  954. Get copy of current connected peers (slow! use GetPeersNonAlloc for best performance)
  955. </summary>
  956. <returns>Array with connected peers</returns>
  957. </member>
  958. <member name="M:LiteNetLib.NetManager.GetPeers(LiteNetLib.ConnectionState)">
  959. <summary>
  960. Get copy of current connected peers (slow! use GetPeersNonAlloc for best performance)
  961. </summary>
  962. <returns>Array with connected peers</returns>
  963. </member>
  964. <member name="M:LiteNetLib.NetManager.GetPeersNonAlloc(System.Collections.Generic.List{LiteNetLib.NetPeer},LiteNetLib.ConnectionState)">
  965. <summary>
  966. Get copy of peers (without allocations)
  967. </summary>
  968. <param name="peers">List that will contain result</param>
  969. <param name="peerState">State of peers</param>
  970. </member>
  971. <member name="M:LiteNetLib.NetManager.DisconnectPeerForce(LiteNetLib.NetPeer)">
  972. <summary>
  973. Immediately disconnect peer from server without additional data
  974. </summary>
  975. <param name="peer">peer to disconnect</param>
  976. </member>
  977. <member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer)">
  978. <summary>
  979. Disconnect peer from server
  980. </summary>
  981. <param name="peer">peer to disconnect</param>
  982. </member>
  983. <member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,System.Byte[])">
  984. <summary>
  985. Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
  986. </summary>
  987. <param name="peer">peer to disconnect</param>
  988. <param name="data">additional data</param>
  989. </member>
  990. <member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,LiteNetLib.Utils.NetDataWriter)">
  991. <summary>
  992. Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
  993. </summary>
  994. <param name="peer">peer to disconnect</param>
  995. <param name="writer">additional data</param>
  996. </member>
  997. <member name="M:LiteNetLib.NetManager.DisconnectPeer(LiteNetLib.NetPeer,System.Byte[],System.Int32,System.Int32)">
  998. <summary>
  999. Disconnect peer from server and send additional data (Size must be less or equal MTU - 8)
  1000. </summary>
  1001. <param name="peer">peer to disconnect</param>
  1002. <param name="data">additional data</param>
  1003. <param name="start">data start</param>
  1004. <param name="count">data length</param>
  1005. </member>
  1006. <member name="T:LiteNetLib.ConnectionState">
  1007. <summary>
  1008. Peer connection state
  1009. </summary>
  1010. </member>
  1011. <member name="T:LiteNetLib.NetPeer">
  1012. <summary>
  1013. Network peer. Main purpose is sending messages to specific peer.
  1014. </summary>
  1015. </member>
  1016. <member name="P:LiteNetLib.NetPeer.ConnectionState">
  1017. <summary>
  1018. Current connection state
  1019. </summary>
  1020. </member>
  1021. <member name="P:LiteNetLib.NetPeer.ConnectTime">
  1022. <summary>
  1023. Connection time for internal purposes
  1024. </summary>
  1025. </member>
  1026. <member name="F:LiteNetLib.NetPeer.Id">
  1027. <summary>
  1028. Peer id can be used as key in your dictionary of peers
  1029. </summary>
  1030. </member>
  1031. <member name="P:LiteNetLib.NetPeer.EndPoint">
  1032. <summary>
  1033. Peer ip address and port
  1034. </summary>
  1035. </member>
  1036. <member name="P:LiteNetLib.NetPeer.Ping">
  1037. <summary>
  1038. Current ping in milliseconds
  1039. </summary>
  1040. </member>
  1041. <member name="P:LiteNetLib.NetPeer.Mtu">
  1042. <summary>
  1043. Current MTU - Maximum Transfer Unit ( maximum udp packet size without fragmentation )
  1044. </summary>
  1045. </member>
  1046. <member name="P:LiteNetLib.NetPeer.RemoteTimeDelta">
  1047. <summary>
  1048. Delta with remote time in ticks (not accurate)
  1049. positive - remote time > our time
  1050. </summary>
  1051. </member>
  1052. <member name="P:LiteNetLib.NetPeer.RemoteUtcTime">
  1053. <summary>
  1054. Remote UTC time (not accurate)
  1055. </summary>
  1056. </member>
  1057. <member name="P:LiteNetLib.NetPeer.TimeSinceLastPacket">
  1058. <summary>
  1059. Time since last packet received (including internal library packets)
  1060. </summary>
  1061. </member>
  1062. <member name="P:LiteNetLib.NetPeer.NetManager">
  1063. <summary>
  1064. Peer parent NetManager
  1065. </summary>
  1066. </member>
  1067. <member name="F:LiteNetLib.NetPeer.Tag">
  1068. <summary>
  1069. Application defined object containing data about the connection
  1070. </summary>
  1071. </member>
  1072. <member name="F:LiteNetLib.NetPeer.Statistics">
  1073. <summary>
  1074. Statistics of peer connection
  1075. </summary>
  1076. </member>
  1077. <member name="M:LiteNetLib.NetPeer.GetMaxSinglePacketSize(LiteNetLib.DeliveryMethod)">
  1078. <summary>
  1079. Gets maximum size of packet that will be not fragmented.
  1080. </summary>
  1081. <param name="options">Type of packet that you want send</param>
  1082. <returns>size in bytes</returns>
  1083. </member>
  1084. <member name="M:LiteNetLib.NetPeer.Send(System.Byte[],LiteNetLib.DeliveryMethod)">
  1085. <summary>
  1086. Send data to peer
  1087. </summary>
  1088. <param name="data">Data</param>
  1089. <param name="options">Send options (reliable, unreliable, etc.)</param>
  1090. <exception cref="T:LiteNetLib.TooBigPacketException">
  1091. If size exceeds maximum limit:<para/>
  1092. MTU - headerSize bytes for Unreliable<para/>
  1093. Fragment count exceeded ushort.MaxValue<para/>
  1094. </exception>
  1095. </member>
  1096. <member name="M:LiteNetLib.NetPeer.Send(LiteNetLib.Utils.NetDataWriter,LiteNetLib.DeliveryMethod)">
  1097. <summary>
  1098. Send data to peer
  1099. </summary>
  1100. <param name="dataWriter">DataWriter with data</param>
  1101. <param name="options">Send options (reliable, unreliable, etc.)</param>
  1102. <exception cref="T:LiteNetLib.TooBigPacketException">
  1103. If size exceeds maximum limit:<para/>
  1104. MTU - headerSize bytes for Unreliable<para/>
  1105. Fragment count exceeded ushort.MaxValue<para/>
  1106. </exception>
  1107. </member>
  1108. <member name="M:LiteNetLib.NetPeer.Send(System.Byte[],System.Int32,System.Int32,LiteNetLib.DeliveryMethod)">
  1109. <summary>
  1110. Send data to peer
  1111. </summary>
  1112. <param name="data">Data</param>
  1113. <param name="start">Start of data</param>
  1114. <param name="length">Length of data</param>
  1115. <param name="options">Send options (reliable, unreliable, etc.)</param>
  1116. <exception cref="T:LiteNetLib.TooBigPacketException">
  1117. If size exceeds maximum limit:<para/>
  1118. MTU - headerSize bytes for Unreliable<para/>
  1119. Fragment count exceeded ushort.MaxValue<para/>
  1120. </exception>
  1121. </member>
  1122. <member name="M:LiteNetLib.NetPeer.Flush">
  1123. <summary>
  1124. Flush all queued packets
  1125. </summary>
  1126. </member>
  1127. <member name="T:LiteNetLib.LocalAddrType">
  1128. <summary>
  1129. Address type that you want to receive from NetUtils.GetLocalIp method
  1130. </summary>
  1131. </member>
  1132. <member name="T:LiteNetLib.NetUtils">
  1133. <summary>
  1134. Some specific network utilities
  1135. </summary>
  1136. </member>
  1137. <member name="M:LiteNetLib.NetUtils.GetLocalIpList(LiteNetLib.LocalAddrType)">
  1138. <summary>
  1139. Get all local ip addresses
  1140. </summary>
  1141. <param name="addrType">type of address (IPv4, IPv6 or both)</param>
  1142. <returns>List with all local ip adresses</returns>
  1143. </member>
  1144. <member name="M:LiteNetLib.NetUtils.GetLocalIpList(System.Collections.Generic.List{System.String},LiteNetLib.LocalAddrType)">
  1145. <summary>
  1146. Get all local ip addresses (non alloc version)
  1147. </summary>
  1148. <param name="targetList">result list</param>
  1149. <param name="addrType">type of address (IPv4, IPv6 or both)</param>
  1150. </member>
  1151. <member name="M:LiteNetLib.NetUtils.GetLocalIp(LiteNetLib.LocalAddrType)">
  1152. <summary>
  1153. Get first detected local ip address
  1154. </summary>
  1155. <param name="addrType">type of address (IPv4, IPv6 or both)</param>
  1156. <returns>IP address if available. Else - string.Empty</returns>
  1157. </member>
  1158. </members>
  1159. </doc>