Class WorldServerSystem

Namespace

FishMMO.Server.Implementation.World.WorldServer

Assembly

FishMMO.Server.dll

Handles world server registration and heartbeat (pulse) updates in the database. Periodically updates the world server's status and character count. Database operations are async to avoid blocking the main thread.

[CreateAssetMenu(fileName = "WorldServerSystem", menuName = "FishMMO/Server/WorldServer/World Server System", order = 1)]
[RequiresDataContainer(typeof(WorldServerSystemRuntimeData))]
[RequiresDataContainer(typeof(AsyncWorkerData))]
public class WorldServerSystem : ServerBehaviour, IServerBehaviour<INetworkManagerWrapper, ServerManager, NetworkConnection, IServerBehaviour>, IServerComponent<INetworkManagerWrapper, ServerManager, NetworkConnection, IServerBehaviour>, IWorldServerSystem, IServerBehaviour, IServerComponent

Inheritance

object

Object

ScriptableObject

ServerBehaviour

WorldServerSystem

Implements

IServerBehaviour<INetworkManagerWrapper, ServerManager, NetworkConnection, IServerBehaviour>

IServerComponent<INetworkManagerWrapper, ServerManager, NetworkConnection, IServerBehaviour>

IWorldServerSystem

IServerBehaviour

IServerComponent

Inherited Members

ServerBehaviour.Initialized

ServerBehaviour.Server

ServerBehaviour.ServerManager

ServerBehaviour.OnLateUpdate(float)

ServerBehaviour.DrainMainThreadQueue<TQueue>(int, bool)

ServerBehaviour.TryEnqueueMainThread<TQueue>(Action)

ServerBehaviour.TryGetDbService<T>(out T)

ServerBehaviour.SendServerBusy(NetworkConnection)

ServerBehaviour.DisconnectWithNotice(NetworkConnection, DisconnectNoticeReason, bool)

ServerBehaviour.TryEnqueueAsyncWork(Func<Task>, long, string)

ServerBehaviour.TryEnqueueAsyncWork(Func<Task>, NetworkConnection, long, string)

ServerBehaviour.EnqueuePersistence(Func<Task>, long, string)

ServerBehaviour.TryBeginInFlightRequest<TRuntime>(NetworkConnection, Func<TRuntime, bool>)

ServerBehaviour.EndInFlightRequest<TRuntime>(NetworkConnection, Action<TRuntime>)

ServerBehaviour.TryEnqueueGuardedAsyncWork(Func<Task>, Action<long>, long, long, string)

ServerBehaviour.OnRemoteConnectionStopped(NetworkConnection)

ServerBehaviour.SubscribeToConnectionEvents()

ServerBehaviour.UnsubscribeFromConnectionEvents()

ServerBehaviour.OnUpdate(float)

ServerBehaviour.Deinitialize()

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

PulseRate

Interval (in seconds) between heartbeat pulses to the database.

public float PulseRate { get; }

Property Value

float

Methods

InitializeOnce()

Initializes the world server system, validates dependencies, registers this world server in the database, and starts periodic pulse callbacks.

public override ServerComponentInitializationStatus InitializeOnce()

Returns

ServerComponentInitializationStatus

The initialization status.

InitializeOnceAsync(CancellationToken)

Initializes the system and registers it in the database without blocking the Unity main thread.

public override Task<ServerComponentInitializationStatus> InitializeOnceAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ServerComponentInitializationStatus>

Remarks

Awaits here deliberately capture Unity's SynchronizationContext (no ConfigureAwait(false)), so execution resumes on the main thread and the Unity and FishNet APIs used below stay legal.

OnDeinitialize()

Called when the system is being destroyed. Deregisters the world server from the database and unregisters periodic callbacks.

public override void OnDeinitialize()

Pulse(int)

Sends a heartbeat/pulse update with the current character count.

public void Pulse(int characterCount)

Parameters

characterCount int

Current character count.

RegisterAsync(string, ushort, int, CancellationToken)

Registers the world server in the database without blocking the Unity main thread.

public Task<bool> RegisterAsync(string serverAddress, ushort port, int characterCount, CancellationToken cancellationToken = default)

Parameters

serverAddress string

Address string.

port ushort

Port number.

characterCount int

Character count to register.

cancellationToken CancellationToken

Cancelled when the server shuts down mid-startup.

Returns

Task<bool>

true when the server was registered.