Class NetPeer

Improved LiteNetPeer with full multi-channel support

Inheritance

object

EndPoint

IPEndPoint

LiteNetPeer

NetPeer

Inherited Members

LiteNetPeer.NetManager

LiteNetPeer.ConnectionState

LiteNetPeer.Id

LiteNetPeer.RemoteId

LiteNetPeer.Ping

LiteNetPeer.RoundTripTime

LiteNetPeer.Mtu

LiteNetPeer.RemoteTimeDelta

LiteNetPeer.RemoteUtcTime

LiteNetPeer.TimeSinceLastPacket

LiteNetPeer.Tag

LiteNetPeer.Statistics

LiteNetPeer.Serialize()

LiteNetPeer.GetHashCode()

LiteNetPeer.GetPacketsCountInReliableQueue(bool)

LiteNetPeer.CreatePacketFromPool(DeliveryMethod)

LiteNetPeer.SendPooledPacket(PooledPacket, int)

LiteNetPeer.GetMaxSinglePacketSize(DeliveryMethod)

LiteNetPeer.SendWithDeliveryEvent(byte[], DeliveryMethod, object)

LiteNetPeer.SendWithDeliveryEvent(byte[], int, int, DeliveryMethod, object)

LiteNetPeer.SendWithDeliveryEvent(NetDataWriter, DeliveryMethod, object)

LiteNetPeer.Send(byte[], DeliveryMethod)

LiteNetPeer.Send(NetDataWriter, DeliveryMethod)

LiteNetPeer.Send(byte[], int, int, DeliveryMethod)

LiteNetPeer.Send(byte[], int, int, byte, DeliveryMethod)

LiteNetPeer.SendWithDeliveryEvent(ReadOnlySpan<byte>, DeliveryMethod, object)

LiteNetPeer.Send(ReadOnlySpan<byte>, DeliveryMethod)

LiteNetPeer.SendInternal(ReadOnlySpan<byte>, byte, DeliveryMethod, object)

LiteNetPeer.Disconnect(byte[])

LiteNetPeer.Disconnect(NetDataWriter)

LiteNetPeer.Disconnect(byte[], int, int)

LiteNetPeer.Disconnect()

IPEndPoint.MaxPort

IPEndPoint.MinPort

IPEndPoint.Create(SocketAddress)

IPEndPoint.Equals(object)

IPEndPoint.ToString()

IPEndPoint.Address

IPEndPoint.AddressFamily

IPEndPoint.Port

Namespace: LiteNetLib

Assembly: LiteNetLib.dll

Syntax

public class NetPeer : LiteNetPeer

Properties

ChannelsCount

Declaration

protected override int ChannelsCount { get; }

Property Value

Type	Description
int

Overrides

LiteNetPeer.ChannelsCount

Methods

CreatePacketFromPool(DeliveryMethod, byte)

Create temporary packet (maximum size MTU - headerSize) to send later without additional copies

Declaration

public PooledPacket CreatePacketFromPool(DeliveryMethod deliveryMethod, byte channelNumber)

Parameters

Type	Name	Description
DeliveryMethod	deliveryMethod	Delivery method (reliable, unreliable, etc.)
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)

Returns

Type	Description
PooledPacket	PooledPacket that you can use to write data starting from UserDataOffset

GetPacketsCountInReliableQueue(byte, bool)

Returns packets count in queue for reliable channel

Declaration

public int GetPacketsCountInReliableQueue(byte channelNumber, bool ordered)

Parameters

Type	Name	Description
byte	channelNumber	number of channel 0-63
bool	ordered	type of channel ReliableOrdered or ReliableUnordered

Returns

Type	Description
int	packets count in channel queue

Send(NetDataWriter, byte, DeliveryMethod)

Send data to peer

Declaration

public void Send(NetDataWriter dataWriter, byte channelNumber, DeliveryMethod deliveryMethod)

Parameters

Type	Name	Description
NetDataWriter	dataWriter	DataWriter with data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Send options (reliable, unreliable, etc.)

Exceptions

Type	Condition
TooBigPacketException	If size exceeds maximum limit: MTU - headerSize bytes for Unreliable Fragment count exceeded ushort.MaxValue

Send(byte[], byte, DeliveryMethod)

Send data to peer

Declaration

public void Send(byte[] data, byte channelNumber, DeliveryMethod deliveryMethod)

Parameters

Type	Name	Description
byte[]	data	Data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Send options (reliable, unreliable, etc.)

Exceptions

Type	Condition
TooBigPacketException	If size exceeds maximum limit: MTU - headerSize bytes for Unreliable Fragment count exceeded ushort.MaxValue

Send(ReadOnlySpan<byte>, byte, DeliveryMethod)

Send data to peer

Declaration

public void Send(ReadOnlySpan<byte> data, byte channelNumber, DeliveryMethod deliveryMethod)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	data	Data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Send options (reliable, unreliable, etc.)

Exceptions

Type	Condition
TooBigPacketException	If size exceeds maximum limit: MTU - headerSize bytes for Unreliable Fragment count exceeded ushort.MaxValue

SendWithDeliveryEvent(NetDataWriter, byte, DeliveryMethod, object)

Send data to peer with delivery event called

Declaration

public void SendWithDeliveryEvent(NetDataWriter dataWriter, byte channelNumber, DeliveryMethod deliveryMethod, object userData)

Parameters

Type	Name	Description
NetDataWriter	dataWriter	Data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Delivery method (reliable, unreliable, etc.)
object	userData	User data that will be received in DeliveryEvent

Exceptions

Type	Condition
ArgumentException	If you trying to send unreliable packet type

SendWithDeliveryEvent(byte[], byte, DeliveryMethod, object)

Send data to peer with delivery event called

Declaration

public void SendWithDeliveryEvent(byte[] data, byte channelNumber, DeliveryMethod deliveryMethod, object userData)

Parameters

Type	Name	Description
byte[]	data	Data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Delivery method (reliable, unreliable, etc.)
object	userData	User data that will be received in DeliveryEvent

Exceptions

Type	Condition
ArgumentException	If you trying to send unreliable packet type

SendWithDeliveryEvent(byte[], int, int, byte, DeliveryMethod, object)

Send data to peer with delivery event called

Declaration

public void SendWithDeliveryEvent(byte[] data, int start, int length, byte channelNumber, DeliveryMethod deliveryMethod, object userData)

Parameters

Type	Name	Description
byte[]	data	Data
int	start	Start of data
int	length	Length of data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Delivery method (reliable, unreliable, etc.)
object	userData	User data that will be received in DeliveryEvent

Exceptions

Type	Condition
ArgumentException	If you trying to send unreliable packet type

SendWithDeliveryEvent(ReadOnlySpan<byte>, byte, DeliveryMethod, object)

Send data to peer with delivery event called

Declaration

public void SendWithDeliveryEvent(ReadOnlySpan<byte> data, byte channelNumber, DeliveryMethod deliveryMethod, object userData)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	data	Data
byte	channelNumber	Number of channel (from 0 to channelsCount - 1)
DeliveryMethod	deliveryMethod	Delivery method (reliable, unreliable, etc.)
object	userData	User data that will be received in DeliveryEvent

Exceptions

Type	Condition
ArgumentException	If you trying to send unreliable packet type

UpdateChannels()

Declaration

protected override void UpdateChannels()

Overrides

LiteNetPeer.UpdateChannels()