9b554f69b0
### Changes/Fixes:
* Adds timer pooling.
* Allows pool to be configurable in ModernUO.json
* Pool replenishes itself asynchronously if depleted.
* Fixes an issue with barkeeps and town criers
* Fixes an issue with incognito buff icons not being removed
* Fixes an issue with polymorph name mod not being removed
* Fixes several places where timers go on forever even after an object is deleted, keeping a reference (memory leak)
* Eliminates the timer for MiningCart altogether.
* Deletes `AcidSlime` since it is a duplicate of `PoolOfAcid`
* Fixes HonorableExecution and standardizes the code for other Bushido moves.
## Changes to the Timer API:
```cs
public class Timer
{
// Creates a timer that will be returned to the pool once execution stops.
public static void StartTimer(Action callback);
public static void StartTimer(TimeSpan delay, Action callback);
public static void StartTimer(TimeSpan delay, TimeSpan interval, Action callback);
public static void StartTimer(TimeSpan interval, int count, Action callback);
public static void StartTimer(TimeSpan delay, TimeSpan interval, int count, Action callback);
// Creates a timer and returns a token for more control. Requires manual cancellation in order for the timer to be returned to the pool.
// If the token is dereferenced, the timer will be dereferenced too. While not returning a timer to the pool is not considered hazardous, it does defeat the purpose of pooled timers.
public static void StartTimer(Action callback, out TimerExecutionToken token);
public static void StartTimer(TimeSpan delay, Action callback, out TimerExecutionToken token);
public static void StartTimer(TimeSpan delay, TimeSpan interval, Action callback, out TimerExecutionToken token);
public static void StartTimer(TimeSpan interval, int count, Action callback, out TimerExecutionToken token);
public static void StartTimer(TimeSpan delay, TimeSpan interval, int count, Action callback, out TimerExecutionToken token);
// If you aren't sure how to use the API above, or you don't care about performance, then you can use the old RunUO Timer.DelayCall
public static DelayCallTimer DelayCall(Action callback);
public static DelayCallTimer DelayCall(TimeSpan delay, Action callback);
public static DelayCallTimer DelayCall(TimeSpan delay, TimeSpan interval, Action callback);
public static DelayCallTimer DelayCall(TimeSpan interval, int count, Action callback);
public static DelayCallTimer DelayCall(TimeSpan delay, TimeSpan interval, int count, Action callback);
}
public struct TimerExecutionToken
{
public bool Running { get; }
public int Index { get; }
public int RemainingCount { get; }
public DateTime Next { get; }
}
```
## When to use `TimerExecutionToken`?
Use tokens when you want to gain the performance benefit of using a pooled timer, but you need one of the following:
* Access to the next time the timer will tick:`token.Next`
* Access to which interval, how many intervals there are, or how many are remaining: `token.Index`, `token.Count`, and `token.RemainingCount`
* Stop a timer manually.
* Determine if the timer is running: `timer.Running`
* See notes below about requirements for using tokens!
## Notes about using the TimerExecutionToken:
When you opt-in to receive a token, you must call `Cancel()` to return the timer. This can be done inside of the callback, or outside of the callback at any time.
If this is not called and your timer is an infinite interval, then you will create a potential memory leak, or null pointer exception in your callback.
If the timer ends and is stopped, but cancel is not called, then the timer will never return to the pool and stay referenced until the token is deleted or cancel is called. (Memory leak)
## Is this thread safe?
No. The ModernUO timer system is not thread safe at all. If you require a thread safe timer system, contact me and I'll help adapt this system. Keep in mind that there is a massive performance hit to make this thread safe when there are literally no use cases for it.
If you need to synchronize execution, meaning you want to execute code from another thread on the core thread. Let's say you have a discord bot that is pushing commands to the game server. Then use `EventLoopContext.Post(SendOrPostCallback callback, object state);`.
70 lines
1.5 KiB
YAML
70 lines
1.5 KiB
YAML
name: 'Build'
|
|
|
|
trigger:
|
|
- main
|
|
|
|
variables:
|
|
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
|
|
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: 1
|
|
|
|
jobs:
|
|
- job: BuildWindows
|
|
displayName: 'Windows Server 2019'
|
|
pool:
|
|
vmImage: 'windows-latest'
|
|
|
|
steps:
|
|
- task: UseDotNet@2
|
|
displayName: 'Install .NET 5'
|
|
inputs:
|
|
packageType: sdk
|
|
version: 5.0.302
|
|
- task: NuGetAuthenticate@0
|
|
- script: ./publish.cmd Release win
|
|
displayName: 'Build'
|
|
- script: dotnet test --no-restore
|
|
displayName: 'Test'
|
|
|
|
- job: BuildLinux
|
|
strategy:
|
|
matrix:
|
|
'CentOS 8':
|
|
containerImage: centos:8
|
|
os: centos.8
|
|
'CentOS 7':
|
|
containerImage: centos:7
|
|
os: centos.7
|
|
'Debian 10':
|
|
containerImage: mcr.microsoft.com/dotnet/sdk:5.0-buster-slim
|
|
os: debian.10
|
|
# 'Debian 11':
|
|
# containerImage: amd64/buildpack-deps:bullseye
|
|
# os: debian.11-x64
|
|
'Ubuntu 20':
|
|
containerImage: mcr.microsoft.com/dotnet/sdk:5.0-focal
|
|
os: ubuntu.20.04
|
|
'Fedora 32':
|
|
containerImage: fedora:32
|
|
os: fedora.32
|
|
'Fedora 33':
|
|
containerImage: fedora:33
|
|
os: fedora.33
|
|
|
|
displayName: Linux
|
|
|
|
pool:
|
|
vmImage: 'ubuntu-latest'
|
|
|
|
container: $[ variables['containerImage'] ]
|
|
|
|
steps:
|
|
- task: UseDotNet@2
|
|
displayName: 'Install .NET 5'
|
|
inputs:
|
|
packageType: sdk
|
|
version: 5.0.302
|
|
- task: NuGetAuthenticate@0
|
|
- script: ./publish.cmd Release $(os)
|
|
displayName: 'Build'
|
|
- script: dotnet test --no-restore
|
|
displayName: 'Test'
|