public interface ISessionAuthenticatorDecides who is allowed in.
No guide page documents this yet — the page shows what the code says about itself.
Remarks
Asked repeatedly rather than awaited. Real authentication talks to an identity provider over the network and cannot answer inside the frame it was asked in, so the hook is allowed to say Pending and be asked again on the next session update. An implementation kicks its own request off on the first call and reports the answer whenever it has one.
That is a polling interface where the obvious design is Task<bool>, and the reason is the frame loop: a completion arriving on a thread pool thread halfway through a frame would have to be marshalled back to the session anyway, and every layer that touches it would then have to be thread-safe for the sake of an event that happens twice a minute. Pending-and-ask-again keeps the session single-threaded and keeps the waiting visible in AuthenticationTimeout.
Methods (1)
AuthenticationDecision Authenticate(in AuthenticationRequest request)Decides, or says it is still deciding.
Used by (4)
- NetworkSessionVixen.Net
- ScriptedAuthenticatorVixen.Net.Tests
- SessionHarnessVixen.Net.Tests
- PlayerAdmissionVixen.Live.Realm