1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>LiteNetLib</name>
- </assembly>
- <members>
- <member name="M:LiteNetLib.ConnectionRequest.Accept">
- <summary>
- Accept connection and get new NetPeer as result
- </summary>
- <returns>Connected NetPeer</returns>
- </member>
- <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(System.Net.IPEndPoint,System.Net.Sockets.SocketError)">
- <summary>
- Network error (on send or receive)
- </summary>
- <param name="endPoint">From endPoint (can be null)</param>
- <param name="socketError">Socket error</param>
- </member>
- <member name="M:LiteNetLib.INetEventListener.OnNetworkReceive(LiteNetLib.NetPeer,LiteNetLib.NetPacketReader,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(System.Net.IPEndPoint,LiteNetLib.NetPacketReader,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.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="F:LiteNetLib.DeliveryMethod.ReliableSequenced">
- <summary>
- Reliable only last packet
- </summary>
- </member>
- <member name="T:LiteNetLib.NetConstants">
- <summary>
- Network constants. Can be tuned from sources for your purposes.
- </summary>
- </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="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.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="F:LiteNetLib.NetManager.AutoRecycle">
- <summary>
- Automatically recycle NetPacketReader after OnReceive event
- </summary>
- </member>
- <member name="P:LiteNetLib.NetManager.FirstPeer">
- <summary>
- First peer. Useful for Client mode
- </summary>
- <returns></returns>
- </member>
- <member name="P:LiteNetLib.NetManager.PeersCount">
- <summary>
- Returns connected peers count
- </summary>
- </member>
- <member name="M:LiteNetLib.NetManager.#ctor(LiteNetLib.INetEventListener)">
- <summary>
- NetManager constructor
- </summary>
- <param name="listener">Network events listener</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.Net.IPAddress,System.Net.IPAddress,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.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[],System.Net.IPEndPoint)">
- <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,System.Net.IPEndPoint)">
- <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,System.Net.IPEndPoint)">
- <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>New NetPeer if new connection, Old NetPeer if already connected</returns>
- <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
- </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>New NetPeer if new connection, Old NetPeer if already connected</returns>
- <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
- </member>
- <member name="M:LiteNetLib.NetManager.Connect(System.Net.IPEndPoint,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>New NetPeer if new connection, Old NetPeer if already connected</returns>
- <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
- </member>
- <member name="M:LiteNetLib.NetManager.Connect(System.Net.IPEndPoint,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>New NetPeer if new connection, Old NetPeer if already connected</returns>
- <exception cref="T:System.InvalidOperationException">Manager is not running. Call <see cref="M:LiteNetLib.NetManager.Start"/></exception>
- </member>
- <member name="M:LiteNetLib.NetManager.Stop">
- <summary>
- Force closes connection and stop all threads.
- </summary>
- </member>
- <member name="M:LiteNetLib.NetManager.Stop(System.Boolean)">
- <summary>
- Force closes connection and stop all threads.
- </summary>
- <param name="sendDisconnectMessages">Send disconnect messages</param>
- </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.ConnectTime">
- <summary>
- Connection time for internal purposes
- </summary>
- </member>
- <member name="F:LiteNetLib.NetPeer.Id">
- <summary>
- Peer id 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.RemoteTimeDelta">
- <summary>
- Delta with remote time in ticks (not accurate)
- positive - remote time > our time
- </summary>
- </member>
- <member name="P:LiteNetLib.NetPeer.RemoteUtcTime">
- <summary>
- Remote UTC time (not accurate)
- </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>
- <exception cref="T:LiteNetLib.TooBigPacketException">
- If size exceeds maximum limit:<para/>
- MTU - headerSize bytes for Unreliable<para/>
- Fragment count exceeded ushort.MaxValue<para/>
- </exception>
- </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>
- <exception cref="T:LiteNetLib.TooBigPacketException">
- If size exceeds maximum limit:<para/>
- MTU - headerSize bytes for Unreliable<para/>
- Fragment count exceeded ushort.MaxValue<para/>
- </exception>
- </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>
- <exception cref="T:LiteNetLib.TooBigPacketException">
- If size exceeds maximum limit:<para/>
- MTU - headerSize bytes for Unreliable<para/>
- Fragment count exceeded ushort.MaxValue<para/>
- </exception>
- </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.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>
- <member name="T:LiteNetLib.Ntp.NtpPacket">
- <summary>
- Represents RFC4330 SNTP packet used for communication to and from a network time server.
- </summary>
- <remarks>
- <para>
- Most applications should just use the <see cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" /> property.
- </para>
- <para>
- The same data structure represents both request and reply packets.
- Request and reply differ in which properties are set and to what values.
- </para>
- <para>
- The only real property is <see cref="P:LiteNetLib.Ntp.NtpPacket.Bytes" />.
- All other properties read from and write to the underlying byte array
- with the exception of <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />,
- which is not part of the packet on network and it is instead set locally after receiving the packet.
- </para>
- <para>
- Copied from <a href="https://guerrillantp.machinezoo.com/">GuerrillaNtp project</a>
- with permission from Robert Vazan (@robertvazan) under MIT license, see https://github.com/RevenantX/LiteNetLib/pull/236
- </para>
- </remarks>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.Bytes">
- <summary>
- Gets RFC4330-encoded SNTP packet.
- </summary>
- <value>
- Byte array containing RFC4330-encoded SNTP packet. It is at least 48 bytes long.
- </value>
- <remarks>
- This is the only real property. All other properties except
- <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" /> read from or write to this byte array.
- </remarks>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.LeapIndicator">
- <summary>
- Gets the leap second indicator.
- </summary>
- <value>
- Leap second warning, if any. Special value
- <see cref="F:LiteNetLib.Ntp.NtpLeapIndicator.AlarmCondition" /> indicates unsynchronized server clock.
- Default is <see cref="F:LiteNetLib.Ntp.NtpLeapIndicator.NoWarning" />.
- </value>
- <remarks>
- Only servers fill in this property. Clients can consult this property for possible leap second warning.
- </remarks>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.VersionNumber">
- <summary>
- Gets or sets protocol version number.
- </summary>
- <value>
- SNTP protocol version. Default is 4, which is the latest version at the time of this writing.
- </value>
- <remarks>
- In request packets, clients should leave this property at default value 4.
- Servers usually reply with the same protocol version.
- </remarks>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.Mode">
- <summary>
- Gets or sets SNTP packet mode, i.e. whether this is client or server packet.
- </summary>
- <value>
- SNTP packet mode. Default is <see cref="F:LiteNetLib.Ntp.NtpMode.Client" /> in newly created packets.
- Server reply should have this property set to <see cref="F:LiteNetLib.Ntp.NtpMode.Server" />.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.Stratum">
- <summary>
- Gets server's distance from the reference clock.
- </summary>
- <value>
- <para>
- Distance from the reference clock. This property is set only in server reply packets.
- Servers connected directly to reference clock hardware set this property to 1.
- Statum number is incremented by 1 on every hop down the NTP server hierarchy.
- </para>
- <para>
- Special value 0 indicates that this packet is a Kiss-o'-Death message
- with kiss code stored in <see cref="P:LiteNetLib.Ntp.NtpPacket.ReferenceId" />.
- </para>
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.Poll">
- <summary>
- Gets server's preferred polling interval.
- </summary>
- <value>
- Polling interval in log2 seconds, e.g. 4 stands for 16s and 17 means 131,072s.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.Precision">
- <summary>
- Gets the precision of server clock.
- </summary>
- <value>
- Clock precision in log2 seconds, e.g. -20 for microsecond precision.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.RootDelay">
- <summary>
- Gets the total round-trip delay from the server to the reference clock.
- </summary>
- <value>
- Round-trip delay to the reference clock. Normally a positive value smaller than one second.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.RootDispersion">
- <summary>
- Gets the estimated error in time reported by the server.
- </summary>
- <value>
- Estimated error in time reported by the server. Normally a positive value smaller than one second.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.ReferenceId">
- <summary>
- Gets the ID of the time source used by the server or Kiss-o'-Death code sent by the server.
- </summary>
- <value>
- <para>
- ID of server's time source or Kiss-o'-Death code.
- Purpose of this property depends on value of <see cref="P:LiteNetLib.Ntp.NtpPacket.Stratum" /> property.
- </para>
- <para>
- Stratum 1 servers write here one of several special values that describe the kind of hardware clock they use.
- </para>
- <para>
- Stratum 2 and lower servers set this property to IPv4 address of their upstream server.
- If upstream server has IPv6 address, the address is hashed, because it doesn't fit in this property.
- </para>
- <para>
- When server sets <see cref="P:LiteNetLib.Ntp.NtpPacket.Stratum" /> to special value 0,
- this property contains so called kiss code that instructs the client to stop querying the server.
- </para>
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.ReferenceTimestamp">
- <summary>
- Gets or sets the time when the server clock was last set or corrected.
- </summary>
- <value>
- Time when the server clock was last set or corrected or <c>null</c> when not specified.
- </value>
- <remarks>
- This Property is usually set only by servers. It usually lags server's current time by several minutes,
- so don't use this property for time synchronization.
- </remarks>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp">
- <summary>
- Gets or sets the time when the client sent its request.
- </summary>
- <value>
- This property is <c>null</c> in request packets.
- In reply packets, it is the time when the client sent its request.
- Servers copy this value from <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />
- that they find in received request packet.
- </value>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp">
- <summary>
- Gets or sets the time when the request was received by the server.
- </summary>
- <value>
- This property is <c>null</c> in request packets.
- In reply packets, it is the time when the server received client request.
- </value>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp">
- <summary>
- Gets or sets the time when the packet was sent.
- </summary>
- <value>
- Time when the packet was sent. It should never be <c>null</c>.
- Default value is <see cref="P:System.DateTime.UtcNow" />.
- </value>
- <remarks>
- This property must be set by both clients and servers.
- </remarks>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp">
- <summary>
- Gets or sets the time of reception of response SNTP packet on the client.
- </summary>
- <value>
- Time of reception of response SNTP packet on the client. It is <c>null</c> in request packets.
- </value>
- <remarks>
- This property is not part of the protocol and has to be set when reply packet is received.
- </remarks>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset" />
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime" />
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.RoundTripTime">
- <summary>
- Gets the round-trip time to the server.
- </summary>
- <value>
- Time the request spent travelling to the server plus the time the reply spent travelling back.
- This is calculated from timestamps in the packet as <c>(t1 - t0) + (t3 - t2)</c>
- where t0 is <see cref="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp" />,
- t1 is <see cref="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp" />,
- t2 is <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />,
- and t3 is <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />.
- This property throws an exception in request packets.
- </value>
- </member>
- <member name="P:LiteNetLib.Ntp.NtpPacket.CorrectionOffset">
- <summary>
- Gets the offset that should be added to local time to synchronize it with server time.
- </summary>
- <value>
- Time difference between server and client. It should be added to local time to get server time.
- It is calculated from timestamps in the packet as <c>0.5 * ((t1 - t0) - (t3 - t2))</c>
- where t0 is <see cref="P:LiteNetLib.Ntp.NtpPacket.OriginTimestamp" />,
- t1 is <see cref="P:LiteNetLib.Ntp.NtpPacket.ReceiveTimestamp" />,
- t2 is <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />,
- and t3 is <see cref="P:LiteNetLib.Ntp.NtpPacket.DestinationTimestamp" />.
- This property throws an exception in request packets.
- </value>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpPacket.#ctor">
- <summary>
- Initializes default request packet.
- </summary>
- <remarks>
- Properties <see cref="P:LiteNetLib.Ntp.NtpPacket.Mode" /> and <see cref="P:LiteNetLib.Ntp.NtpPacket.VersionNumber" />
- are set appropriately for request packet. Property <see cref="P:LiteNetLib.Ntp.NtpPacket.TransmitTimestamp" />
- is set to <see cref="P:System.DateTime.UtcNow" />.
- </remarks>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpPacket.#ctor(System.Byte[])">
- <summary>
- Initializes packet from received data.
- </summary>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpPacket.FromServerResponse(System.Byte[],System.DateTime)">
- <summary>
- Initializes packet from data received from a server.
- </summary>
- <param name="bytes">Data received from the server.</param>
- <param name="destinationTimestamp">Utc time of reception of response SNTP packet on the client.</param>
- <returns></returns>
- </member>
- <member name="T:LiteNetLib.Ntp.NtpLeapIndicator">
- <summary>
- Represents leap second warning from the server that instructs the client to add or remove leap second.
- </summary>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.LeapIndicator" />
- </member>
- <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.NoWarning">
- <summary>
- No leap second warning. No action required.
- </summary>
- </member>
- <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.LastMinuteHas61Seconds">
- <summary>
- Warns the client that the last minute of the current day has 61 seconds.
- </summary>
- </member>
- <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.LastMinuteHas59Seconds">
- <summary>
- Warns the client that the last minute of the current day has 59 seconds.
- </summary>
- </member>
- <member name="F:LiteNetLib.Ntp.NtpLeapIndicator.AlarmCondition">
- <summary>
- Special value indicating that the server clock is unsynchronized and the returned time is unreliable.
- </summary>
- </member>
- <member name="T:LiteNetLib.Ntp.NtpMode">
- <summary>
- Describes SNTP packet mode, i.e. client or server.
- </summary>
- <seealso cref="P:LiteNetLib.Ntp.NtpPacket.Mode" />
- </member>
- <member name="F:LiteNetLib.Ntp.NtpMode.Client">
- <summary>
- Identifies client-to-server SNTP packet.
- </summary>
- </member>
- <member name="F:LiteNetLib.Ntp.NtpMode.Server">
- <summary>
- Identifies server-to-client SNTP packet.
- </summary>
- </member>
- <member name="T:LiteNetLib.Ntp.NtpRequest">
- <summary>
- Make NTP request.
- <para>
- 1. Create the object by <see cref="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})"/> method.
- </para>
- <para>
- 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
- AFTER you have received the response or some timeout. If you close the socket too early, you may miss the response.
- </para>
- <para>
- 3. Call <see cref="M:LiteNetLib.Ntp.NtpRequest.Close"/> to release the socket AFTER you have received the response or some timeout.
- If you close the socket too early, you may miss the response.
- </para>
- </summary>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.#ctor(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})">
- <summary>
- Initialize object, open socket.
- </summary>
- <param name="onRequestComplete">callback (called from other thread!)</param>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPEndPoint,System.Action{LiteNetLib.Ntp.NtpPacket})">
- <summary>
- Create the requests for NTP server, open socket.
- </summary>
- <param name="endPoint">NTP Server address.</param>
- <param name="onRequestComplete">callback (called from other thread!)</param>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.Net.IPAddress,System.Action{LiteNetLib.Ntp.NtpPacket})">
- <summary>
- Create the requests for NTP server (default port), open socket.
- </summary>
- <param name="ipAddress">NTP Server address.</param>
- <param name="onRequestComplete">callback (called from other thread!)</param>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.Create(System.String,System.Int32,System.Action{LiteNetLib.Ntp.NtpPacket})">
- <summary>
- Create the requests for NTP server, open socket.
- </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.Ntp.NtpRequest.Create(System.String,System.Action{LiteNetLib.Ntp.NtpPacket})">
- <summary>
- Create the requests for NTP server (default port), open socket.
- </summary>
- <param name="ntpServerAddress">NTP Server address.</param>
- <param name="onRequestComplete">callback (called from other thread!)</param>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.Send">
- <summary>
- Send request to the NTP server calls callback (if success).
- In case of error the callbacke is called with null param.
- </summary>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.Close">
- <summary>
- Close socket.
- </summary>
- </member>
- <member name="M:LiteNetLib.Ntp.NtpRequest.LiteNetLib#INetSocketListener#OnMessageReceived(System.Byte[],System.Int32,System.Net.Sockets.SocketError,System.Net.IPEndPoint)">
- <summary>
- Handle received data: transform bytes to NtpPacket, close socket and call the callback.
- </summary>
- </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>
- <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.ParseException">Malformed packet</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </member>
- <member name="M:LiteNetLib.Utils.NetPacketProcessor.RemoveSubscription``1">
- <summary>
- Remove any subscriptions by type
- </summary>
- <typeparam name="T">Packet type</typeparam>
- <returns>true if remove is success</returns>
- </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.Register``1">
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- <exception cref="T:LiteNetLib.Utils.InvalidTypeException"><typeparamref name="T"/>'s fields are not supported, or it has no fields</exception>
- </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>
- </members>
- </doc>
|