Add multiplayer session FIFO facade

This commit is contained in:
Andrew Barnes
2026-08-06 15:24:31 -04:00
parent 112120e8fe
commit bd6c606303
2 changed files with 187 additions and 0 deletions
+103
View File
@@ -0,0 +1,103 @@
local Session = {}
Session.__index = Session
local VALID_ROLES = { host = true, guest = true }
local REQUIRED_METHODS = { "update", "poll", "send", "close" }
function Session.new(transport, options)
assert(type(transport) == "table", "Session.new requires a transport")
assert(type(options) == "table", "Session.new requires options")
assert(VALID_ROLES[options.role], "Session role must be host or guest")
assert(type(options.kind) == "string" and options.kind ~= "",
"Session kind must be a non-empty string")
for _, method in ipairs(REQUIRED_METHODS) do
assert(type(transport[method]) == "function",
"Session transport requires " .. method)
end
local self = setmetatable({
_transport = transport,
_role = options.role,
_kind = options.kind,
_inbox = {},
_status = "connecting",
_terminal = nil,
_transportCloseCalled = false,
paired = false,
closed = false,
error = nil,
code = nil,
address = nil,
target = nil,
}, Session)
self:_syncMetadata()
self:_refreshStatus()
return self
end
function Session:_syncMetadata()
local transport = self._transport
self.paired = transport.paired == true
self.code = transport.code
self.address = transport.address
self.target = transport.target
end
function Session:_refreshStatus()
if not self._terminal then
self._status = self.paired and "paired" or "connecting"
self.closed = false
self.error = nil
end
end
function Session:getRole() return self._role end
function Session:getKind() return self._kind end
function Session:getStatus() return self._status end
function Session:getFailure() return nil, nil end
function Session:hasPending() return #self._inbox > 0 end
function Session:send(message)
if self._terminal then return nil end
return self._transport:send(message)
end
function Session:update()
if self._terminal then return end
self._transport:update()
self:_syncMetadata()
local messages = self._transport:poll()
for _, message in ipairs(messages) do
self._inbox[#self._inbox + 1] = message
end
self:_refreshStatus()
end
function Session:take(messageType)
assert(type(messageType) == "string", "Session.take requires a message type")
for index, message in ipairs(self._inbox) do
if message.type == messageType then
return table.remove(self._inbox, index)
end
end
return nil
end
function Session:pollOne()
if #self._inbox == 0 then return nil end
return table.remove(self._inbox, 1)
end
function Session:poll()
local messages = self._inbox
self._inbox = {}
return messages
end
function Session:close()
if self._transportCloseCalled then return end
self._transportCloseCalled = true
self._transport:close()
end
return Session
+84
View File
@@ -0,0 +1,84 @@
package.path = "./?.lua;./?/init.lua;" .. package.path
local T = require("tests.modkit")
local Net = require("src.link.Net")
local Session = require("src.link.Session")
local function sessionPair()
local hostNet, guestNet = Net.loopbackPair()
return Session.new(hostNet, { role = "host", kind = "link" }),
Session.new(guestNet, { role = "guest", kind = "link" })
end
do
local host, guest = sessionPair()
T.eq(host:getRole(), "host", "host role is assigned locally")
T.eq(guest:getRole(), "guest", "guest role is assigned locally")
T.eq(host:getKind(), "link", "session kind is retained")
T.eq(host:getStatus(), "paired", "wrapped loopback starts paired")
guest:send({
type = "hello", name = "BLUE", role = "host", kind = "tournament",
})
host:update()
local hello = host:take("hello")
T.eq(hello.name, "BLUE", "send forwards the original payload")
T.eq(hello.session, nil, "send adds no session envelope")
T.eq(host:getRole(), "host", "peer payload cannot replace local role")
T.eq(host:getKind(), "link", "peer payload cannot replace local kind")
end
do
local host, guest = sessionPair()
guest:send({ type = "before", sequence = 1 })
guest:send({ type = "hello", sequence = 2 })
guest:send({ type = "after", sequence = 3 })
guest:send({ type = "hello", sequence = 4 })
host:update()
local hello = host:take("hello")
T.eq(hello.sequence, 2, "take removes the first matching packet")
T.eq(host:pollOne().sequence, 1, "pollOne removes only the FIFO head")
local rest = host:poll()
T.eq(#rest, 2, "poll returns every remaining packet once")
T.eq(rest[1].sequence, 3, "take preserves the earlier remainder order")
T.eq(rest[2].sequence, 4, "take preserves repeated-type order")
T.eq(#host:poll(), 0, "poll clears the private FIFO")
end
do
local sent
local transport = {
paired = false,
code = nil,
address = "192.0.2.5:7777",
target = "ROOM01",
update = function(self)
self.paired = true
self.code = "ROOM02"
end,
poll = function() return {} end,
send = function(_, message)
sent = message
return "queued", 7
end,
close = function(self) self.closed = true end,
}
local session = Session.new(transport, { role = "guest", kind = "tournament" })
T.eq(session:getStatus(), "connecting", "unpaired transport starts connecting")
T.eq(session.address, "192.0.2.5:7777", "address metadata is mirrored")
T.eq(session.target, "ROOM01", "target metadata is mirrored")
local outbound = { type = "ping" }
local result, count = session:send(outbound)
T.eq(result, "queued", "send preserves the transport's first return")
T.eq(count, 7, "send preserves the transport's second return")
T.eq(sent, outbound, "send forwards the original table unchanged")
session:update()
T.eq(session:getStatus(), "paired", "update observes transport pairing")
T.eq(session.code, "ROOM02", "update refreshes relay metadata")
end
T.finish("link_session")