Show / Hide Table of Contents

Class NetPacketProcessor

Inheritance
System.Object
NetPacketProcessor
Namespace: LiteNetLib.Utils
Assembly: LiteNetLib.dll
Syntax
public class NetPacketProcessor

Constructors

NetPacketProcessor()

Declaration
public NetPacketProcessor()

NetPacketProcessor(Int32)

Declaration
public NetPacketProcessor(int maxStringLength)
Parameters
Type Name Description
System.Int32 maxStringLength

Methods

GetCallbackFromData(NetDataReader)

Declaration
protected virtual NetPacketProcessor.SubscribeDelegate GetCallbackFromData(NetDataReader reader)
Parameters
Type Name Description
NetDataReader reader
Returns
Type Description
LiteNetLib.Utils.NetPacketProcessor.SubscribeDelegate

GetHash<T>()

Declaration
protected virtual ulong GetHash<T>()
Returns
Type Description
System.UInt64
Type Parameters
Name Description
T

ReadAllPackets(NetDataReader)

Reads all available data from NetDataReader and calls OnReceive delegates

Declaration
public void ReadAllPackets(NetDataReader reader)
Parameters
Type Name Description
NetDataReader reader

NetDataReader with packets data

ReadAllPackets(NetDataReader, Object)

Reads all available data from NetDataReader and calls OnReceive delegates

Declaration
public void ReadAllPackets(NetDataReader reader, object userData)
Parameters
Type Name Description
NetDataReader reader

NetDataReader with packets data

System.Object userData

Argument that passed to OnReceivedEvent

Exceptions
Type Condition
ParseException

Malformed packet

ReadPacket(NetDataReader)

Reads one packet from NetDataReader and calls OnReceive delegate

Declaration
public void ReadPacket(NetDataReader reader)
Parameters
Type Name Description
NetDataReader reader

NetDataReader with packet

Exceptions
Type Condition
ParseException

Malformed packet

ReadPacket(NetDataReader, Object)

Reads one packet from NetDataReader and calls OnReceive delegate

Declaration
public void ReadPacket(NetDataReader reader, object userData)
Parameters
Type Name Description
NetDataReader reader

NetDataReader with packet

System.Object userData

Argument that passed to OnReceivedEvent

Exceptions
Type Condition
ParseException

Malformed packet

RegisterNestedType<T>()

Register nested property type

Declaration
public void RegisterNestedType<T>()
    where T : struct, INetSerializable
Type Parameters
Name Description
T

INetSerializable structure

RegisterNestedType<T>(Action<NetDataWriter, T>, Func<NetDataReader, T>)

Register nested property type

Declaration
public void RegisterNestedType<T>(Action<NetDataWriter, T> writeDelegate, Func<NetDataReader, T> readDelegate)
Parameters
Type Name Description
System.Action<NetDataWriter, T> writeDelegate
System.Func<NetDataReader, T> readDelegate
Type Parameters
Name Description
T

RegisterNestedType<T>(Func<T>)

Register nested property type

Declaration
public void RegisterNestedType<T>(Func<T> constructor)
    where T : class, INetSerializable
Parameters
Type Name Description
System.Func<T> constructor
Type Parameters
Name Description
T

INetSerializable class

RemoveSubscription<T>()

Remove any subscriptions by type

Declaration
public bool RemoveSubscription<T>()
Returns
Type Description
System.Boolean

true if remove is success

Type Parameters
Name Description
T

Packet type

Send<T>(NetManager, T, DeliveryMethod)

Declaration
public void Send<T>(NetManager manager, T packet, DeliveryMethod options)
    where T : class, new()
Parameters
Type Name Description
NetManager manager
T packet
DeliveryMethod options
Type Parameters
Name Description
T

Send<T>(NetPeer, T, DeliveryMethod)

Declaration
public void Send<T>(NetPeer peer, T packet, DeliveryMethod options)
    where T : class, new()
Parameters
Type Name Description
NetPeer peer
T packet
DeliveryMethod options
Type Parameters
Name Description
T

SendNetSerializable<T>(NetManager, T, DeliveryMethod)

Declaration
public void SendNetSerializable<T>(NetManager manager, T packet, DeliveryMethod options)
    where T : INetSerializable
Parameters
Type Name Description
NetManager manager
T packet
DeliveryMethod options
Type Parameters
Name Description
T

SendNetSerializable<T>(NetPeer, T, DeliveryMethod)

Declaration
public void SendNetSerializable<T>(NetPeer peer, T packet, DeliveryMethod options)
    where T : INetSerializable
Parameters
Type Name Description
NetPeer peer
T packet
DeliveryMethod options
Type Parameters
Name Description
T

Subscribe<T>(Action<T>, Func<T>)

Register and subscribe to packet receive event

Declaration
public void Subscribe<T>(Action<T> onReceive, Func<T> packetConstructor)
    where T : class, new()
Parameters
Type Name Description
System.Action<T> onReceive

event that will be called when packet deserialized with ReadPacket method

System.Func<T> packetConstructor

Method that constructs packet intead of slow Activator.CreateInstance

Type Parameters
Name Description
T
Exceptions
Type Condition
InvalidTypeException

T's fields are not supported, or it has no fields

Subscribe<T, TUserData>(Action<T, TUserData>, Func<T>)

Register and subscribe to packet receive event (with userData)

Declaration
public void Subscribe<T, TUserData>(Action<T, TUserData> onReceive, Func<T> packetConstructor)
    where T : class, new()
Parameters
Type Name Description
System.Action<T, TUserData> onReceive

event that will be called when packet deserialized with ReadPacket method

System.Func<T> packetConstructor

Method that constructs packet intead of slow Activator.CreateInstance

Type Parameters
Name Description
T
TUserData
Exceptions
Type Condition
InvalidTypeException

T's fields are not supported, or it has no fields

SubscribeNetSerializable<T>(Action<T>)

Declaration
public void SubscribeNetSerializable<T>(Action<T> onReceive)
    where T : INetSerializable, new()
Parameters
Type Name Description
System.Action<T> onReceive
Type Parameters
Name Description
T

SubscribeNetSerializable<T>(Action<T>, Func<T>)

Declaration
public void SubscribeNetSerializable<T>(Action<T> onReceive, Func<T> packetConstructor)
    where T : INetSerializable
Parameters
Type Name Description
System.Action<T> onReceive
System.Func<T> packetConstructor
Type Parameters
Name Description
T

SubscribeNetSerializable<T, TUserData>(Action<T, TUserData>)

Declaration
public void SubscribeNetSerializable<T, TUserData>(Action<T, TUserData> onReceive)
    where T : INetSerializable, new()
Parameters
Type Name Description
System.Action<T, TUserData> onReceive
Type Parameters
Name Description
T
TUserData

SubscribeNetSerializable<T, TUserData>(Action<T, TUserData>, Func<T>)

Declaration
public void SubscribeNetSerializable<T, TUserData>(Action<T, TUserData> onReceive, Func<T> packetConstructor)
    where T : INetSerializable
Parameters
Type Name Description
System.Action<T, TUserData> onReceive
System.Func<T> packetConstructor
Type Parameters
Name Description
T
TUserData

SubscribeReusable<T>(Action<T>)

Register and subscribe to packet receive event This metod will overwrite last received packet class on receive (less garbage)

Declaration
public void SubscribeReusable<T>(Action<T> onReceive)
    where T : class, new()
Parameters
Type Name Description
System.Action<T> onReceive

event that will be called when packet deserialized with ReadPacket method

Type Parameters
Name Description
T
Exceptions
Type Condition
InvalidTypeException

T's fields are not supported, or it has no fields

SubscribeReusable<T, TUserData>(Action<T, TUserData>)

Register and subscribe to packet receive event This metod will overwrite last received packet class on receive (less garbage)

Declaration
public void SubscribeReusable<T, TUserData>(Action<T, TUserData> onReceive)
    where T : class, new()
Parameters
Type Name Description
System.Action<T, TUserData> onReceive

event that will be called when packet deserialized with ReadPacket method

Type Parameters
Name Description
T
TUserData
Exceptions
Type Condition
InvalidTypeException

T's fields are not supported, or it has no fields

Write<T>(T)

Declaration
public byte[] Write<T>(T packet)
    where T : class, new()
Parameters
Type Name Description
T packet
Returns
Type Description
System.Byte[]
Type Parameters
Name Description
T

Write<T>(NetDataWriter, T)

Declaration
public void Write<T>(NetDataWriter writer, T packet)
    where T : class, new()
Parameters
Type Name Description
NetDataWriter writer
T packet
Type Parameters
Name Description
T

WriteHash<T>(NetDataWriter)

Declaration
protected virtual void WriteHash<T>(NetDataWriter writer)
Parameters
Type Name Description
NetDataWriter writer
Type Parameters
Name Description
T

WriteNetSerializable<T>(T)

Declaration
public byte[] WriteNetSerializable<T>(T packet)
    where T : INetSerializable
Parameters
Type Name Description
T packet
Returns
Type Description
System.Byte[]
Type Parameters
Name Description
T

WriteNetSerializable<T>(NetDataWriter, T)

Declaration
public void WriteNetSerializable<T>(NetDataWriter writer, T packet)
    where T : INetSerializable
Parameters
Type Name Description
NetDataWriter writer
T packet
Type Parameters
Name Description
T
Back to top Generated by DocFX