My Project
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Properties | List of all members
LiteNetLib.NetPeer Class Reference

Network peer. Main purpose is sending messages to specific peer. More...

Public Member Functions

int GetPacketsCountInReliableQueue (byte channelNumber, bool ordered)
 Returns packets count in queue for reliable channel.
 
int GetMaxSinglePacketSize (DeliveryMethod options)
 Gets maximum size of packet that will be not fragmented.
 
void SendWithDeliveryEvent (byte[] data, byte channelNumber, DeliveryMethod deliveryMethod, object userData)
 Send data to peer with delivery event called.
 
void SendWithDeliveryEvent (byte[] data, int start, int length, byte channelNumber, DeliveryMethod deliveryMethod, object userData)
 Send data to peer with delivery event called.
 
void SendWithDeliveryEvent (NetDataWriter dataWriter, byte channelNumber, DeliveryMethod deliveryMethod, object userData)
 Send data to peer with delivery event called.
 
void Send (byte[] data, DeliveryMethod deliveryMethod)
 Send data to peer (channel - 0)
 
void Send (NetDataWriter dataWriter, DeliveryMethod deliveryMethod)
 Send data to peer (channel - 0)
 
void Send (byte[] data, int start, int length, DeliveryMethod options)
 Send data to peer (channel - 0)
 
void Send (byte[] data, byte channelNumber, DeliveryMethod deliveryMethod)
 Send data to peer.
 
void Send (NetDataWriter dataWriter, byte channelNumber, DeliveryMethod deliveryMethod)
 Send data to peer.
 
void Send (byte[] data, int start, int length, byte channelNumber, DeliveryMethod deliveryMethod)
 Send data to peer.
 
void Disconnect (byte[] data)
 
void Disconnect (NetDataWriter writer)
 
void Disconnect (byte[] data, int start, int count)
 
void Disconnect ()
 

Public Attributes

readonly IPEndPoint EndPoint
 Peer ip address and port.
 
readonly NetManager NetManager
 Peer parent NetManager.
 
readonly int Id
 Peer id can be used as key in your dictionary of peers.
 
object Tag
 Application defined object containing data about the connection.
 
readonly NetStatistics Statistics
 Statistics of peer connection.
 

Properties

ConnectionState ConnectionState [get]
 Current connection state.
 
int Ping [get]
 Current ping in milliseconds.
 
int Mtu [get]
 Current MTU - Maximum Transfer Unit ( maximum udp packet size without fragmentation )
 
long RemoteTimeDelta [get]
 Delta with remote time in ticks (not accurate) positive - remote time > our time.
 
DateTime RemoteUtcTime [get]
 Remote UTC time (not accurate)
 
int TimeSinceLastPacket [get]
 Time since last packet received (including internal library packets)
 

Detailed Description

Network peer. Main purpose is sending messages to specific peer.

Member Function Documentation

◆ GetMaxSinglePacketSize()

int LiteNetLib.NetPeer.GetMaxSinglePacketSize ( DeliveryMethod  options)
inline

Gets maximum size of packet that will be not fragmented.

Parameters
optionsType of packet that you want send
Returns
size in bytes

◆ GetPacketsCountInReliableQueue()

int LiteNetLib.NetPeer.GetPacketsCountInReliableQueue ( byte  channelNumber,
bool  ordered 
)
inline

Returns packets count in queue for reliable channel.

Parameters
channelNumbernumber of channel 0-63
orderedtype of channel ReliableOrdered or ReliableUnordered
Returns
packets count in channel queue

◆ Send() [1/6]

void LiteNetLib.NetPeer.Send ( byte[]  data,
byte  channelNumber,
DeliveryMethod  deliveryMethod 
)
inline

Send data to peer.

Parameters
dataData
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodSend options (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ Send() [2/6]

void LiteNetLib.NetPeer.Send ( byte[]  data,
DeliveryMethod  deliveryMethod 
)
inline

Send data to peer (channel - 0)

Parameters
dataData
deliveryMethodSend options (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ Send() [3/6]

void LiteNetLib.NetPeer.Send ( byte[]  data,
int  start,
int  length,
byte  channelNumber,
DeliveryMethod  deliveryMethod 
)
inline

Send data to peer.

Parameters
dataData
startStart of data
lengthLength of data
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodDelivery method (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ Send() [4/6]

void LiteNetLib.NetPeer.Send ( byte[]  data,
int  start,
int  length,
DeliveryMethod  options 
)
inline

Send data to peer (channel - 0)

Parameters
dataData
startStart of data
lengthLength of data
optionsSend options (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ Send() [5/6]

void LiteNetLib.NetPeer.Send ( NetDataWriter  dataWriter,
byte  channelNumber,
DeliveryMethod  deliveryMethod 
)
inline

Send data to peer.

Parameters
dataWriterDataWriter with data
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodSend options (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ Send() [6/6]

void LiteNetLib.NetPeer.Send ( NetDataWriter  dataWriter,
DeliveryMethod  deliveryMethod 
)
inline

Send data to peer (channel - 0)

Parameters
dataWriterDataWriter with data
deliveryMethodSend options (reliable, unreliable, etc.)
Exceptions
TooBigPacketExceptionIf size exceeds maximum limit:

MTU - headerSize bytes for Unreliable

Fragment count exceeded ushort.MaxValue

◆ SendWithDeliveryEvent() [1/3]

void LiteNetLib.NetPeer.SendWithDeliveryEvent ( byte[]  data,
byte  channelNumber,
DeliveryMethod  deliveryMethod,
object  userData 
)
inline

Send data to peer with delivery event called.

Parameters
dataData
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodDelivery method (reliable, unreliable, etc.)
userDataUser data that will be received in DeliveryEvent
Exceptions
ArgumentExceptionIf you trying to send unreliable packet type

◆ SendWithDeliveryEvent() [2/3]

void LiteNetLib.NetPeer.SendWithDeliveryEvent ( byte[]  data,
int  start,
int  length,
byte  channelNumber,
DeliveryMethod  deliveryMethod,
object  userData 
)
inline

Send data to peer with delivery event called.

Parameters
dataData
startStart of data
lengthLength of data
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodDelivery method (reliable, unreliable, etc.)
userDataUser data that will be received in DeliveryEvent
Exceptions
ArgumentExceptionIf you trying to send unreliable packet type

◆ SendWithDeliveryEvent() [3/3]

void LiteNetLib.NetPeer.SendWithDeliveryEvent ( NetDataWriter  dataWriter,
byte  channelNumber,
DeliveryMethod  deliveryMethod,
object  userData 
)
inline

Send data to peer with delivery event called.

Parameters
dataWriterData
channelNumberNumber of channel (from 0 to channelsCount - 1)
deliveryMethodDelivery method (reliable, unreliable, etc.)
userDataUser data that will be received in DeliveryEvent
Exceptions
ArgumentExceptionIf you trying to send unreliable packet type

The documentation for this class was generated from the following file: