Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added bit-acks #4

Merged
merged 21 commits into from
Sep 3, 2019
Merged

feat: Added bit-acks #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
a3781b0
feat: Added fragmentation
TwoTenPvP Aug 14, 2019
e259a40
Added fragmented channel
TwoTenPvP Aug 14, 2019
7106e81
fix: Fixed various fragmentation issues
TwoTenPvP Sep 2, 2019
4d80340
Finalized ReliableSequencedFragmented channel
TwoTenPvP Sep 2, 2019
73258c1
Merge branch 'fragmentation' of https://github.com/TwoTenPvP/Ruffles …
TwoTenPvP Sep 2, 2019
e4b6a3d
Pooled pointer arrays
TwoTenPvP Sep 2, 2019
6909e77
Fixed fragment resending
TwoTenPvP Sep 3, 2019
2474e70
Added unit tests
TwoTenPvP Sep 3, 2019
c62031f
Adjusted defaults and added validation to SocketConfig
TwoTenPvP Sep 3, 2019
be6eca7
Updated readme
TwoTenPvP Sep 3, 2019
c12620b
Removed old comment
TwoTenPvP Sep 3, 2019
6b0e8bf
Added print when an invalid channel got a message
TwoTenPvP Sep 3, 2019
731cdba
fix: Fixes hashcash difficulty
TwoTenPvP Sep 3, 2019
e1a2900
Updated socketConfig to use more reasonable defaults
TwoTenPvP Sep 3, 2019
b184b32
Reduced example difficulty
TwoTenPvP Sep 3, 2019
eb295f2
feat: Added unconnected messages
TwoTenPvP Sep 3, 2019
a34d895
feat: Added bit-acks
TwoTenPvP Sep 3, 2019
2de1afd
feat: Added bit-ack to ReliableChannel
TwoTenPvP Sep 3, 2019
debc548
Merge branch 'master' into bit-acks
TwoTenPvP Sep 3, 2019
cfbc15d
refactor: Removed duplicate configs
TwoTenPvP Sep 3, 2019
af2d5f3
doc(xml): Added xml documentation for config
TwoTenPvP Sep 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 44 additions & 2 deletions Ruffles/Channeling/Channels/ReliableChannel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,33 @@ public void HandleAck(ArraySegment<byte> payload)
// Read the sequence number
ushort sequence = (ushort)(payload.Array[payload.Offset] | (ushort)(payload.Array[payload.Offset + 1] << 8));

// Handle the base ack
HandleAck(sequence);

if ((payload.Count - 2) > 0)
{
// There is more data. This has to be ack bits

// Calculate the amount of ack bits
int bits = (payload.Count - 2) * 8;

// Iterate ack bits
for (byte i = 0; i < bits; i++)
{
// Get the ack for the current bit
bool isAcked = ((payload.Array[payload.Offset + 2 + (i / 8)] & ((byte)Math.Pow(2, (7 - (i % 8))))) >> (7 - (i % 8))) == 1;

if (isAcked)
{
// Handle the bit ack
HandleAck((ushort)(sequence - i));
}
}
}
}

private void HandleAck(ushort sequence)
{
if (_sendSequencer[sequence].Alive)
{
// Dealloc the memory held by the sequencer
Expand Down Expand Up @@ -233,7 +260,7 @@ public void Reset()
private void SendAck(ushort sequence)
{
// Alloc ack memory
HeapMemory ackMemory = memoryManager.AllocHeapMemory(4);
HeapMemory ackMemory = memoryManager.AllocHeapMemory(4 + (uint)(config.EnableMergedAcks ? config.MergedAckBytes : 0));

// Write header
ackMemory.Buffer[0] = HeaderPacker.Pack((byte)MessageType.Ack, false);
Expand All @@ -243,8 +270,23 @@ private void SendAck(ushort sequence)
ackMemory.Buffer[2] = (byte)sequence;
ackMemory.Buffer[3] = (byte)(sequence >> 8);

if (config.EnableMergedAcks)
{
// Reset the memory
for (int i = 0; i < config.MergedAckBytes; i++)
{
ackMemory.Buffer[4 + i] = 0;
}

// Set the bit fields
for (byte i = 0; i < config.MergedAckBytes * 8; i++)
{
ackMemory.Buffer[(i / 8)] |= (byte)(((SequencingUtils.Distance(((ushort)(sequence - (i + 1))), _incomingLowestAckedSequence, sizeof(ushort)) <= 0 || _incomingAckedPackets.Contains(((ushort)(sequence - (i + 1))))) ? 1 : 0) << (7 - (i % 8)));
}
}

// Send ack
connection.SendRaw(new ArraySegment<byte>(ackMemory.Buffer, 0, 4), false);
connection.SendRaw(new ArraySegment<byte>(ackMemory.Buffer, 0, 4 + (config.EnableMergedAcks ? config.MergedAckBytes : 0)), false);

// Return memory
memoryManager.DeAlloc(ackMemory);
Expand Down
46 changes: 44 additions & 2 deletions Ruffles/Channeling/Channels/ReliableSequencedChannel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,33 @@ public void HandleAck(ArraySegment<byte> payload)
// Read the sequence number
ushort sequence = (ushort)(payload.Array[payload.Offset] | (ushort)(payload.Array[payload.Offset + 1] << 8));

// Handle the base ack
HandleAck(sequence);

if ((payload.Count - 2) > 0)
{
// There is more data. This has to be ack bits

// Calculate the amount of ack bits
int bits = (payload.Count - 2) * 8;

// Iterate ack bits
for (byte i = 0; i < bits; i++)
{
// Get the ack for the current bit
bool isAcked = ((payload.Array[payload.Offset + 2 + (i / 8)] & ((byte)Math.Pow(2, (7 - (i % 8))))) >> (7 - (i % 8))) == 1;

if (isAcked)
{
// Handle the bit ack
HandleAck((ushort)(sequence - i));
}
}
}
}

private void HandleAck(ushort sequence)
{
if (_sendSequencer[sequence].Alive)
{
// Dealloc the memory held by the sequencer for the packet
Expand Down Expand Up @@ -242,7 +269,7 @@ public void Reset()
private void SendAck(ushort sequence)
{
// Alloc ack memory
HeapMemory ackMemory = memoryManager.AllocHeapMemory(4);
HeapMemory ackMemory = memoryManager.AllocHeapMemory(4 + (uint)(config.EnableMergedAcks ? config.MergedAckBytes : 0));

// Write header
ackMemory.Buffer[0] = HeaderPacker.Pack((byte)MessageType.Ack, false);
Expand All @@ -252,8 +279,23 @@ private void SendAck(ushort sequence)
ackMemory.Buffer[2] = (byte)sequence;
ackMemory.Buffer[3] = (byte)(sequence >> 8);

if (config.EnableMergedAcks)
{
// Reset the memory
for (int i = 0; i < config.MergedAckBytes; i++)
{
ackMemory.Buffer[4 + i] = 0;
}

// Set the bit fields
for (byte i = 0; i < config.MergedAckBytes * 8; i++)
{
ackMemory.Buffer[(i / 8)] |= (byte)(((SequencingUtils.Distance(((ushort)(sequence - (i + 1))), _incomingLowestAckedSequence, sizeof(ushort)) <= 0 || _receiveSequencer[((ushort)(sequence - (i + 1)))].Alive) ? 1 : 0) << (7 - (i % 8)));
}
}

// Send ack
connection.SendRaw(new ArraySegment<byte>(ackMemory.Buffer, 0, 4), false);
connection.SendRaw(new ArraySegment<byte>(ackMemory.Buffer, 0, 4 + (config.EnableMergedAcks ? config.MergedAckBytes : 0)), false);

// Return memory
memoryManager.DeAlloc(ackMemory);
Expand Down
10 changes: 9 additions & 1 deletion Ruffles/Configuration/SocketConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,15 @@ public class SocketConfig
/// <summary>
/// The maximum delay before merged packets are sent.
/// </summary>
public ulong MaxMergeDelay = 250;
public ulong MaxMergeDelay = 250;
/// <summary>
/// Whether or not to enable merged acks for non fragmented channels.
/// </summary>
public bool EnableMergedAcks = true;
/// <summary>
/// The amount of bytes to use for merged acks.
/// </summary>
public byte MergedAckBytes = 8;

// Fragmentation
/// <summary>
Expand Down