Class ConnectionRequest -
+ + + +Class ConnectionRequest
Inheritance
-Inherited Members
+ + + + + + + + + + +Namespace: LiteNetLib
Assembly: LiteNetLib.dll
Syntax
public class ConnectionRequest
- Fields -
- - -Data
- - -Declaration
-public readonly NetDataReader Data
+ public class ConnectionRequest : LiteConnectionRequest
Field Value
-| Type | -Description | -
|---|---|
| NetDataReader | -- |
RemoteEndPoint
- - -Declaration
-public readonly IPEndPoint RemoteEndPoint
- Field Value
-| Type | -Description | -
|---|---|
| System.Net.IPEndPoint | -- |
Methods -
- - + + +Accept()
Accept connection and get new NetPeer as result
Declaration
+Declaration
public NetPeer Accept()
Returns
-| Type | @@ -165,18 +150,19 @@
|---|
AcceptIfKey(String)
- +AcceptIfKey(string)
+Accepts the connection if the first string in the Data matches the provided key.
+Declaration
+Declaration
public NetPeer AcceptIfKey(string key)
Parameters
-| Type | @@ -186,14 +172,15 @@||||
|---|---|---|---|---|
| System.String | +string | key | -+ | The required string key to match. + |
Returns
-| Type | @@ -203,257 +190,19 @@|
|---|---|
| NetPeer | -- |
Reject()
- - -Declaration
-public void Reject()
- Reject(NetDataWriter)
- - -Declaration
-public void Reject(NetDataWriter rejectData)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetDataWriter | -rejectData | -- |
Reject(Byte[])
- - -Declaration
-public void Reject(byte[] rejectData)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Byte[] | -rejectData | -- |
Reject(Byte[], Int32, Int32)
- - -Declaration
-public void Reject(byte[] rejectData, int start, int length)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Byte[] | -rejectData | -- |
| System.Int32 | -start | -- |
| System.Int32 | -length | -- |
Reject(Byte[], Int32, Int32, Boolean)
- - -Declaration
-public void Reject(byte[] rejectData, int start, int length, bool force)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Byte[] | -rejectData | -- |
| System.Int32 | -start | -- |
| System.Int32 | -length | -- |
| System.Boolean | -force | -- |
RejectForce()
- - -Declaration
-public void RejectForce()
- RejectForce(NetDataWriter)
- - -Declaration
-public void RejectForce(NetDataWriter rejectData)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetDataWriter | -rejectData | -- |
RejectForce(Byte[])
- - -Declaration
-public void RejectForce(byte[] rejectData)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Byte[] | -rejectData | -- |
RejectForce(Byte[], Int32, Int32)
- - -Declaration
-public void RejectForce(byte[] rejectData, int start, int length)
- Parameters
-| Type | -Name | -Description | -|
|---|---|---|---|
| System.Byte[] | -rejectData | -- | |
| System.Int32 | -start | -- | |
| System.Int32 | -length | -+ | A new LiteNetPeer if the key matches and connection is accepted; otherwise, |
Remarks
+This is a helper method for simple password/key validation. +If the key does not match or data is invalid, the connection is automatically rejected.
+Parameters
-
@@ -59,7 +57,7 @@
Enum ConnectionState -
+ + + + +Enum ConnectionState
Peer connection state
Syntax
public enum ConnectionState : byteFields -
-| Name | Description | ||
|---|---|---|---|
| Any | @@ -105,6 +104,10 @@ | Disconnected | |
| EndPointChange | ++ | ||
| Outgoing | @@ -114,10 +117,10 @@ |
Fields
-
@@ -59,7 +57,7 @@
Enum DeliveryMethod -
+ + + + +Enum DeliveryMethod
Sending method type
Syntax
public enum DeliveryMethod : byte
Fields -
-| Name | Description | |
|---|---|---|
| ReliableOrdered | -Reliable and ordered. Packets won't be dropped, won't be duplicated, will arrive in order. + | Reliable and ordered. Packets won't be dropped, won't be duplicated, will arrive in order. |
| ReliableSequenced | -Reliable only last packet. Packets can be dropped (except the last one), won't be duplicated, will arrive in order. + | Reliable only last packet. Packets can be dropped (except the last one), won't be duplicated, will arrive in order. Cannot be fragmented |
| ReliableUnordered | -Reliable. Packets won't be dropped, won't be duplicated, can arrive without order. + | Reliable. Packets won't be dropped, won't be duplicated, can arrive without order. |
| Sequenced | -Unreliable. Packets can be dropped, won't be duplicated, will arrive in order. + | Unreliable. Packets can be dropped, won't be duplicated, will arrive in order. |
Fields
-
@@ -59,7 +57,7 @@
Struct DisconnectInfo -
+ + + +Struct DisconnectInfo
Additional information about disconnection
Syntax
public struct DisconnectInfo
Fields -
- - + + +AdditionalData
Additional data that can be accessed (only if reason is RemoteConnectionClose)
Declaration
+Declaration
public NetPacketReader AdditionalData
Field Value
-| Type | @@ -109,18 +107,18 @@
|---|
Reason
Additional info why peer disconnected
Declaration
+Declaration
public DisconnectReason Reason
Field Value
-| Type | @@ -134,18 +132,18 @@
|---|
SocketErrorCode
Error code (if reason is SocketSendError or SocketReceiveError)
Declaration
+Declaration
public SocketError SocketErrorCode
Field Value
-| Type | @@ -154,14 +152,15 @@||
|---|---|---|
| System.Net.Sockets.SocketError | +SocketError |
Field Value
-
@@ -59,7 +57,7 @@
Enum DisconnectReason -
+ + + + +Enum DisconnectReason
Disconnect reason that you receive in OnPeerDisconnected event
Syntax
public enum DisconnectReason
Fields -
-| Name | Description | |
|---|---|---|
| ConnectionFailed | -+ | Connection to host failed + |
| ConnectionRejected | -+ | Connection rejected by remote host + |
| DisconnectPeerCalled | -+ | Disconnect called locally + |
| HostUnreachable | @@ -116,6 +118,10 @@NetworkUnreachable | |
| PeerNotFound | ++ | |
| PeerToPeerConnection | @@ -126,21 +132,23 @@ | |
| RemoteConnectionClose | -+ | Remote host disconnected peer + |
| Timeout | -+ | Timeout + |
| UnknownHost |
Fields
-
+
+
Class EventBasedLiteNetListener
+Simple event based listener for simple setups and benchmarks
+Inheritance
+Implements
+ +Namespace: LiteNetLib
+Assembly: LiteNetLib.dll
+Syntax
+public class EventBasedLiteNetListener : ILiteNetEventListener
+ Methods +
+ + + +ClearConnectionRequestEvent()
+Clears all subscribers from ConnectionRequestEvent.
+Declaration
+public void ClearConnectionRequestEvent()
+ ClearDeliveryEvent()
+Clears all subscribers from DeliveryEvent.
+Declaration
+public void ClearDeliveryEvent()
+ ClearNetworkErrorEvent()
+Clears all subscribers from NetworkErrorEvent.
+Declaration
+public void ClearNetworkErrorEvent()
+ ClearNetworkLatencyUpdateEvent()
+Clears all subscribers from NetworkLatencyUpdateEvent.
+Declaration
+public void ClearNetworkLatencyUpdateEvent()
+ ClearNetworkReceiveEvent()
+Clears all subscribers from NetworkReceiveEvent.
+Declaration
+public void ClearNetworkReceiveEvent()
+ ClearNetworkReceiveUnconnectedEvent()
+Clears all subscribers from NetworkReceiveUnconnectedEvent.
+Declaration
+public void ClearNetworkReceiveUnconnectedEvent()
+ ClearPeerAddressChangedEvent()
+Clears all subscribers from PeerAddressChangedEvent.
+Declaration
+public void ClearPeerAddressChangedEvent()
+ ClearPeerConnectedEvent()
+Clears all subscribers from PeerConnectedEvent.
+Declaration
+public void ClearPeerConnectedEvent()
+ ClearPeerDisconnectedEvent()
+Clears all subscribers from PeerDisconnectedEvent.
+Declaration
+public void ClearPeerDisconnectedEvent()
+ Events +
+ + +ConnectionRequestEvent
+Occurs when a new connection request is received.
+Declaration
+public event EventBasedLiteNetListener.OnConnectionRequest ConnectionRequestEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnConnectionRequest | ++ |
DeliveryEvent
+Occurs when a reliable packet is successfully delivered or acknowledged.
+Declaration
+public event EventBasedLiteNetListener.OnDeliveryEvent DeliveryEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnDeliveryEvent | ++ |
NetworkErrorEvent
+Occurs when a network error is detected in the underlying socket.
+Declaration
+public event EventBasedLiteNetListener.OnNetworkError NetworkErrorEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnNetworkError | ++ |
NetworkLatencyUpdateEvent
+Occurs when the round-trip time (RTT) to a peer is updated.
+Declaration
+public event EventBasedLiteNetListener.OnNetworkLatencyUpdate NetworkLatencyUpdateEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnNetworkLatencyUpdate | ++ |
NetworkReceiveEvent
+Occurs when data is received from a connected peer.
+Declaration
+public event EventBasedLiteNetListener.OnNetworkReceive NetworkReceiveEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnNetworkReceive | ++ |
NetworkReceiveUnconnectedEvent
+Occurs when a message is received from an unconnected endpoint.
+Declaration
+public event EventBasedLiteNetListener.OnNetworkReceiveUnconnected NetworkReceiveUnconnectedEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnNetworkReceiveUnconnected | ++ |
PeerAddressChangedEvent
+Occurs when a peer's remote address changes.
+Declaration
+public event EventBasedLiteNetListener.OnPeerAddressChangedEvent PeerAddressChangedEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnPeerAddressChangedEvent | ++ |
PeerConnectedEvent
+Occurs when a new peer has successfully connected.
+Declaration
+public event EventBasedLiteNetListener.OnPeerConnected PeerConnectedEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnPeerConnected | ++ |
PeerDisconnectedEvent
+Occurs when a peer disconnects or the connection is lost.
+Declaration
+public event EventBasedLiteNetListener.OnPeerDisconnected PeerDisconnectedEvent
+ Event Type
+| Type | +Description | +
|---|---|
| EventBasedLiteNetListener.OnPeerDisconnected | ++ |
Implements
+ + +-
+
-
@@ -59,7 +57,7 @@
Class EventBasedNatPunchListener -
- + + + +Class EventBasedNatPunchListener
+An implementation of INatPunchListener that maps callbacks to events.
+Inheritance
-Implements
Syntax
public class EventBasedNatPunchListener : INatPunchListener
Events -
- - + + +NatIntroductionRequest
- +Event triggered when a NAT introduction request is received.
+Declaration
+Declaration
public event EventBasedNatPunchListener.OnNatIntroductionRequest NatIntroductionRequest
Event Type
-| Type | @@ -111,22 +111,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNatPunchListener.OnNatIntroductionRequest | +EventBasedNatPunchListener.OnNatIntroductionRequest |
NatIntroductionSuccess
- +Event triggered when NAT punchthrough is successfully completed.
+Declaration
+Declaration
public event EventBasedNatPunchListener.OnNatIntroductionSuccess NatIntroductionSuccess
Event Type
-| Type | @@ -135,83 +136,7 @@|
|---|---|
| LiteNetLib.EventBasedNatPunchListener.OnNatIntroductionSuccess | -- |
Explicit Interface Implementations -
- - - -INatPunchListener.OnNatIntroductionRequest(IPEndPoint, IPEndPoint, String)
- - -Declaration
-void INatPunchListener.OnNatIntroductionRequest(IPEndPoint localEndPoint, IPEndPoint remoteEndPoint, string token)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Net.IPEndPoint | -localEndPoint | -- |
| System.Net.IPEndPoint | -remoteEndPoint | -- |
| System.String | -token | -- |
INatPunchListener.OnNatIntroductionSuccess(IPEndPoint, NatAddressType, String)
- - -Declaration
-void INatPunchListener.OnNatIntroductionSuccess(IPEndPoint targetEndPoint, NatAddressType type, string token)
- Parameters
-| Type | -Name | -Description | -||
|---|---|---|---|---|
| System.Net.IPEndPoint | -targetEndPoint | -- | ||
| NatAddressType | -type | -- | ||
| System.String | -token | +EventBasedNatPunchListener.OnNatIntroductionSuccess |
| Type | @@ -205,22 +223,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnConnectionRequest | +EventBasedNetListener.OnConnectionRequest |
DeliveryEvent
- +Occurs when a reliable packet is successfully delivered or acknowledged.
+Declaration
+Declaration
public event EventBasedNetListener.OnDeliveryEvent DeliveryEvent
Event Type
-| Type | @@ -229,22 +248,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnDeliveryEvent | +EventBasedNetListener.OnDeliveryEvent |
NetworkErrorEvent
- +Occurs when a network error is detected in the underlying socket.
+Declaration
+Declaration
public event EventBasedNetListener.OnNetworkError NetworkErrorEvent
Event Type
-| Type | @@ -253,22 +273,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnNetworkError | +EventBasedNetListener.OnNetworkError |
NetworkLatencyUpdateEvent
- +Occurs when the round-trip time (RTT) to a peer is updated.
+Declaration
+Declaration
public event EventBasedNetListener.OnNetworkLatencyUpdate NetworkLatencyUpdateEvent
Event Type
-| Type | @@ -277,22 +298,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnNetworkLatencyUpdate | +EventBasedNetListener.OnNetworkLatencyUpdate |
NetworkReceiveEvent
- +Occurs when data is received from a connected peer.
+Declaration
+Declaration
public event EventBasedNetListener.OnNetworkReceive NetworkReceiveEvent
Event Type
-| Type | @@ -301,22 +323,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnNetworkReceive | +EventBasedNetListener.OnNetworkReceive |
NetworkReceiveUnconnectedEvent
- +Occurs when a message is received from an unconnected endpoint.
+Declaration
+Declaration
public event EventBasedNetListener.OnNetworkReceiveUnconnected NetworkReceiveUnconnectedEvent
Event Type
-| Type | @@ -325,22 +348,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnNetworkReceiveUnconnected | +EventBasedNetListener.OnNetworkReceiveUnconnected |
NtpResponseEvent
- +Occurs when an NTP response is received.
+Declaration
+Declaration
public event EventBasedNetListener.OnNtpResponseEvent NtpResponseEvent
Event Type
-| Type | @@ -349,22 +373,23 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnNtpResponseEvent | +EventBasedNetListener.OnNtpResponseEvent |
PeerConnectedEvent
- + + +PeerAddressChangedEvent
+Occurs when a peer's remote address changes.
+Declaration
+Declaration
public event EventBasedNetListener.OnPeerConnected PeerConnectedEvent
+ public event EventBasedNetListener.OnPeerAddressChangedEvent PeerAddressChangedEvent
Event Type
-| Type | @@ -373,316 +398,57 @@||
|---|---|---|
| LiteNetLib.EventBasedNetListener.OnPeerConnected | +EventBasedNetListener.OnPeerAddressChangedEvent |
PeerDisconnectedEvent
- + + +PeerConnectedEvent
+Occurs when a new peer has successfully connected.
+Declaration
+Declaration
public event EventBasedNetListener.OnPeerDisconnected PeerDisconnectedEvent
+ public event EventBasedNetListener.OnPeerConnected PeerConnectedEvent
Event Type
-| Type | -Description | -
|---|---|
| LiteNetLib.EventBasedNetListener.OnPeerDisconnected | -- |
Explicit Interface Implementations -
- - - -IDeliveryEventListener.OnMessageDelivered(NetPeer, Object)
- - -Declaration
-void IDeliveryEventListener.OnMessageDelivered(NetPeer peer, object userData)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetPeer | -peer | -- |
| System.Object | -userData | -- |
INetEventListener.OnConnectionRequest(ConnectionRequest)
- - -Declaration
-void INetEventListener.OnConnectionRequest(ConnectionRequest request)
- Parameters
-| Type | -Name | Description | |
|---|---|---|---|
| ConnectionRequest | -request | +EventBasedNetListener.OnPeerConnected |
INetEventListener.OnNetworkError(IPEndPoint, SocketError)
- - -Declaration
-void INetEventListener.OnNetworkError(IPEndPoint endPoint, SocketError socketErrorCode)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Net.IPEndPoint | -endPoint | -- |
| System.Net.Sockets.SocketError | -socketErrorCode | -- |
INetEventListener.OnNetworkLatencyUpdate(NetPeer, Int32)
- - -Declaration
-void INetEventListener.OnNetworkLatencyUpdate(NetPeer peer, int latency)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetPeer | -peer | -- |
| System.Int32 | -latency | -- |
INetEventListener.OnNetworkReceive(NetPeer, NetPacketReader, DeliveryMethod)
- - -Declaration
-void INetEventListener.OnNetworkReceive(NetPeer peer, NetPacketReader reader, DeliveryMethod deliveryMethod)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetPeer | -peer | -- |
| NetPacketReader | -reader | -- |
| DeliveryMethod | -deliveryMethod | -- |
INetEventListener.OnNetworkReceiveUnconnected(IPEndPoint, NetPacketReader, UnconnectedMessageType)
- - -Declaration
-void INetEventListener.OnNetworkReceiveUnconnected(IPEndPoint remoteEndPoint, NetPacketReader reader, UnconnectedMessageType messageType)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| System.Net.IPEndPoint | -remoteEndPoint | -- |
| NetPacketReader | -reader | -- |
| UnconnectedMessageType | -messageType | -- |
INetEventListener.OnPeerConnected(NetPeer)
- - -Declaration
-void INetEventListener.OnPeerConnected(NetPeer peer)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetPeer | -peer | -- |
INetEventListener.OnPeerDisconnected(NetPeer, DisconnectInfo)
- - -Declaration
-void INetEventListener.OnPeerDisconnected(NetPeer peer, DisconnectInfo disconnectInfo)
- Parameters
-| Type | -Name | -Description | -
|---|---|---|
| NetPeer | -peer | -- |
| DisconnectInfo | -disconnectInfo | -- |
INtpEventListener.OnNtpResponse(NtpPacket)
- + + +PeerDisconnectedEvent
+Occurs when a peer disconnects or the connection is lost.
+Declaration
+Declaration
void INtpEventListener.OnNtpResponse(NtpPacket packet)
+ public event EventBasedNetListener.OnPeerDisconnected PeerDisconnectedEvent
Parameters
-| Type | -Name | Description | ||
|---|---|---|---|---|
| NtpPacket | -packet | +EventBasedNetListener.OnPeerDisconnected |
| Type | @@ -110,15 +108,16 @@|||
|---|---|---|---|
| System.Object | +object | userData |
Parameters
-
+
+
Interface ILiteNetEventListener
+Interface for implementing own ILiteNetEventListener. This is a bit faster than use EventBasedListener
+Namespace: LiteNetLib
+Assembly: LiteNetLib.dll
+Syntax
+public interface ILiteNetEventListener
+ Methods +
+ + + +OnConnectionRequest(LiteConnectionRequest)
+On peer connection requested
+Declaration
+void OnConnectionRequest(LiteConnectionRequest request)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteConnectionRequest | +request | +Request information (EndPoint, internal id, additional data) + |
+
OnMessageDelivered(LiteNetPeer, object)
+On reliable message delivered
+Declaration
+void OnMessageDelivered(LiteNetPeer peer, object userData)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | ++ |
| object | +userData | ++ |
OnNetworkError(IPEndPoint, SocketError)
+Network error (on send or receive)
+Declaration
+void OnNetworkError(IPEndPoint endPoint, SocketError socketError)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| IPEndPoint | +endPoint | +From endPoint (can be null) + |
+
| SocketError | +socketError | +Socket error + |
+
OnNetworkLatencyUpdate(LiteNetPeer, int)
+Latency information updated
+Declaration
+void OnNetworkLatencyUpdate(LiteNetPeer peer, int latency)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | +Peer with updated latency + |
+
| int | +latency | +latency value in milliseconds + |
+
OnNetworkReceive(LiteNetPeer, NetPacketReader, DeliveryMethod)
+Received some data
+Declaration
+void OnNetworkReceive(LiteNetPeer peer, NetPacketReader reader, DeliveryMethod deliveryMethod)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | +From peer + |
+
| NetPacketReader | +reader | +DataReader containing all received data + |
+
| DeliveryMethod | +deliveryMethod | +Type of received packet + |
+
OnNetworkReceiveUnconnected(IPEndPoint, NetPacketReader, UnconnectedMessageType)
+Received unconnected message
+Declaration
+void OnNetworkReceiveUnconnected(IPEndPoint remoteEndPoint, NetPacketReader reader, UnconnectedMessageType messageType)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| IPEndPoint | +remoteEndPoint | +From address (IP and Port) + |
+
| NetPacketReader | +reader | +Message data + |
+
| UnconnectedMessageType | +messageType | +Message type (simple, discovery request or response) + |
+
OnPeerAddressChanged(LiteNetPeer, IPEndPoint)
+Called when peer address changed (when AllowPeerAddressChange is enabled)
+Declaration
+void OnPeerAddressChanged(LiteNetPeer peer, IPEndPoint previousAddress)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | +Peer that changed address (with new address) + |
+
| IPEndPoint | +previousAddress | +previous IP + |
+
OnPeerConnected(LiteNetPeer)
+New remote peer connected to host, or client connected to remote host
+Declaration
+void OnPeerConnected(LiteNetPeer peer)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | +Connected peer object + |
+
OnPeerDisconnected(LiteNetPeer, DisconnectInfo)
+Peer disconnected
+Declaration
+void OnPeerDisconnected(LiteNetPeer peer, DisconnectInfo disconnectInfo)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| LiteNetPeer | +peer | +disconnected peer + |
+
| DisconnectInfo | +disconnectInfo | +additional info about reason, errorCode or data received with disconnect message + |
+
-
+
-
@@ -59,7 +57,7 @@
Interface INatPunchListener -
- + + + +Interface INatPunchListener
+Interface for handling events related to NAT punchthrough and introduction.
+Namespace: LiteNetLib
Assembly: LiteNetLib.dll
@@ -82,19 +81,20 @@Syntax
public interface INatPunchListener
Methods -
- - + + + -OnNatIntroductionRequest(IPEndPoint, IPEndPoint, String)
- +OnNatIntroductionRequest(IPEndPoint, IPEndPoint, string)
+Called when a NAT introduction request is received from the mediator server.
+Declaration
+Declaration
void OnNatIntroductionRequest(IPEndPoint localEndPoint, IPEndPoint remoteEndPoint, string token)
Parameters
-| Type | @@ -104,34 +104,38 @@||||
|---|---|---|---|---|
| System.Net.IPEndPoint | +IPEndPoint | localEndPoint | -+ | The local endpoint of the client requesting connection. + |
| System.Net.IPEndPoint | +IPEndPoint | remoteEndPoint | -+ | The remote endpoint of the client requesting connection. + |
| System.String | +string | token | -+ | Custom data token associated with the request. + |
OnNatIntroductionSuccess(IPEndPoint, NatAddressType, String)
- +OnNatIntroductionSuccess(IPEndPoint, NatAddressType, string)
+Called when NAT punchthrough is successful and a direct connection can be established.
+Declaration
+Declaration
void OnNatIntroductionSuccess(IPEndPoint targetEndPoint, NatAddressType type, string token)
Parameters
-| Type | @@ -141,25 +145,29 @@||||
|---|---|---|---|---|
| System.Net.IPEndPoint | +IPEndPoint | targetEndPoint | -+ | The resolved endpoint of the remote peer. + |
| NatAddressType | type | -+ | The type of address (Internal or External) that succeeded. + |
|
| System.String | +string | token | -+ | Custom data token associated with the request. + |
Parameters
-
@@ -59,7 +57,7 @@
Interface INetEventListener -
- + + + +Interface INetEventListener
+Interface for implementing own INetEventListener. This is a bit faster than use EventBasedListener
+Namespace: LiteNetLib
Assembly: LiteNetLib.dll
@@ -82,20 +81,20 @@Syntax
public interface INetEventListener
Methods -
- - + + +OnConnectionRequest(ConnectionRequest)
On peer connection requested
Declaration
+Declaration
void OnConnectionRequest(ConnectionRequest request)
Parameters
-| Type | @@ -112,19 +111,52 @@
|---|
OnMessageDelivered(NetPeer, object)
+On reliable message delivered
+Declaration
+void OnMessageDelivered(NetPeer peer, object userData)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| NetPeer | +peer | ++ |
| object | +userData | ++ |
OnNetworkError(IPEndPoint, SocketError)
Network error (on send or receive)
Declaration
+Declaration
void OnNetworkError(IPEndPoint endPoint, SocketError socketError)
Parameters
-| Type | @@ -134,32 +166,32 @@|||
|---|---|---|---|
| System.Net.IPEndPoint | +IPEndPoint | endPoint | From endPoint (can be null) |
| System.Net.Sockets.SocketError | +SocketError | socketError | Socket error |
OnNetworkLatencyUpdate(NetPeer, Int32)
+OnNetworkLatencyUpdate(NetPeer, int)
Latency information updated
Declaration
+Declaration
void OnNetworkLatencyUpdate(NetPeer peer, int latency)
Parameters
-| Type | @@ -175,26 +207,26 @@|||
|---|---|---|---|
| System.Int32 | +int | latency | latency value in milliseconds |
OnNetworkReceive(NetPeer, NetPacketReader, DeliveryMethod)
+OnNetworkReceive(NetPeer, NetPacketReader, byte, DeliveryMethod)
Received some data
Declaration
+Declaration
void OnNetworkReceive(NetPeer peer, NetPacketReader reader, DeliveryMethod deliveryMethod)
+ void OnNetworkReceive(NetPeer peer, NetPacketReader reader, byte channelNumber, DeliveryMethod deliveryMethod)
Parameters
-| Type | @@ -213,6 +245,12 @@NetPacketReader | reader | DataReader containing all received data + |
+
|---|---|---|---|
| byte | +channelNumber | +Number of channel at which packet arrived |
|
OnNetworkReceiveUnconnected(IPEndPoint, NetPacketReader, UnconnectedMessageType)
Received unconnected message
Declaration
+Declaration
void OnNetworkReceiveUnconnected(IPEndPoint remoteEndPoint, NetPacketReader reader, UnconnectedMessageType messageType)
Parameters
-| Type | @@ -245,7 +283,7 @@|||
|---|---|---|---|
| System.Net.IPEndPoint | +IPEndPoint | remoteEndPoint | From address (IP and Port) |
@@ -264,19 +302,82 @@
OnNtpResponse(NtpPacket)
+Ntp response
+Declaration
+void OnNtpResponse(NtpPacket packet)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| NtpPacket | +packet | ++ |
OnPeerAddressChanged(NetPeer, IPEndPoint)
+Called when peer address changed (when AllowPeerAddressChange is enabled)
+Declaration
+void OnPeerAddressChanged(NetPeer peer, IPEndPoint previousAddress)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| NetPeer | +peer | +Peer that changed address (with new address) + |
+
| IPEndPoint | +previousAddress | +previous IP + |
+
OnPeerConnected(NetPeer)
New remote peer connected to host, or client connected to remote host
Declaration
+Declaration
void OnPeerConnected(NetPeer peer)
Parameters
-| Type | @@ -293,19 +394,19 @@
|---|
OnPeerDisconnected(NetPeer, DisconnectInfo)
Peer disconnected
Declaration
+Declaration
void OnPeerDisconnected(NetPeer peer, DisconnectInfo disconnectInfo)
Parameters
-| Type | @@ -328,9 +429,10 @@
|---|
Parameters
-
@@ -59,7 +57,7 @@
Interface INetLogger -
+ + + +Interface INetLogger
Interface to implement for your own logger
Syntax
public interface INetLogger
Methods -
- - + + + -WriteNet(NetLogLevel, String, Object[])
+WriteNet(NetLogLevel, string, params object[])
-Declaration
+Declaration
void WriteNet(NetLogLevel level, string str, params object[] args)
Parameters
-| Type | @@ -110,20 +108,21 @@|||
|---|---|---|---|
| System.String | +string | str | |
| System.Object[] | +object[] | args |
Parameters
-
@@ -59,7 +57,7 @@
Interface INtpEventListener -
+ + + +Interface INtpEventListener
Namespace: LiteNetLib
@@ -82,20 +80,20 @@Syntax
public interface INtpEventListener
Methods -
- - + + +OnNtpResponse(NtpPacket)
Ntp response
Declaration
+Declaration
void OnNtpResponse(NtpPacket packet)
Parameters
-| Type | @@ -111,9 +109,10 @@
|---|
Parameters
-
+
+
Interface IPeerAddressChangedListener
+ + +Namespace: LiteNetLib
+Assembly: LiteNetLib.dll
+Syntax
+public interface IPeerAddressChangedListener
+ Methods +
+ + + +OnPeerAddressChanged(NetPeer, IPEndPoint)
+Called when peer address changed (when AllowPeerAddressChange is enabled)
+Declaration
+void OnPeerAddressChanged(NetPeer peer, IPEndPoint previousAddress)
+ Parameters
+| Type | +Name | +Description | +
|---|---|---|
| NetPeer | +peer | +Peer that changed address (with new address) + |
+
| IPEndPoint | +previousAddress | +previous IP + |
+
-
+
-
@@ -59,7 +57,7 @@
Enum IPv6Mode -
+ + + + +Enum IPv6Mode
Namespace: LiteNetLib
@@ -82,15 +81,15 @@Syntax
public enum IPv6Mode
Fields -
-| Name | Description | |
|---|---|---|
| Disabled | @@ -104,10 +103,10 @@ |
Fields
-
@@ -59,7 +57,7 @@
Class InvalidPacketException -
+ + + +Class InvalidPacketException
Inheritance
-Implements
-Inherited Members
Namespace: LiteNetLib
Assembly: LiteNetLib.dll
Syntax
public class InvalidPacketException : ArgumentException, _Exception, ISerializable
+ public class InvalidPacketException : ArgumentException, ISerializable
Constructors -
- - + + + -InvalidPacketException(String)
+InvalidPacketException(string)
-Declaration
+Declaration
public InvalidPacketException(string message)
Parameters
-| Type | @@ -160,7 +160,7 @@|||
|---|---|---|---|
| System.String | +string | message |