Skip to content

Commit

Permalink
docs: updating PacketType comments
Browse files Browse the repository at this point in the history
  • Loading branch information
James-Frowen committed Aug 31, 2023
1 parent 4b99385 commit b9e18a9
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions Assets/Mirage/Runtime/SocketLayer/Enums/PacketType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ public enum PacketType
Command = 1,

/// <summary>
/// data packet sent with no guarantee for order or reliablity
/// data packet sent with no guarantee for order or reliability
/// <para>used for data that is fire and forget</para>
/// </summary>
Unreliable = 2,
Expand All @@ -19,17 +19,20 @@ public enum PacketType
Notify = 3,

/// <summary>
/// packet with just acks
/// data packet that are guarantee to be in order, and not lost.
/// <para>contains ack header</para>
/// <para>If a package is lost then other Reliable packets will be held until the lost packet is resent</para>
/// </summary>
Reliable = 4,

/// <summary>
/// packet with just acks
/// part of a Reliable message. same as Reliable but only part of a message
/// </summary>
ReliableFragment = 6,

/// <summary>
/// packet with just acks
/// packet with just ack header
/// <para>only sent if no other packets with ack header were sent recently</para>
/// </summary>
Ack = 5,

Expand Down

0 comments on commit b9e18a9

Please sign in to comment.