warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(timers): Adds timer pooling, fixes timer related bugs, and changes timer api (#667)

Browse source 
### 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);`.
This commit is contained in:
Kamron Batman 2021-08-07 14:33:35 -07:00 • committed by GitHub
parent b4de631f96
commit 9b554f69b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
219 changed files with 1897 additions and 2241 deletions
Download patch file Download diff file Expand all files Collapse all files

113
Projects/UOContent/Items/Special/Mutation Core/PlagueBeastBlood.cs
View file

@ -5,14 +5,15 @@ namespace Server.Items
{
public class PlagueBeastBlood : PlagueBeastComponent
{
private readonly Timer m_Timer;
public PlagueBeastBlood() : base(0x122C, 0) => m_Timer = Timer.DelayCall(
TimeSpan.FromSeconds(1.5),
TimeSpan.FromSeconds(1.5),
3,
Hemorrhage
);
public PlagueBeastBlood() : base(0x122C, 0)
{
Timer.StartTimer(
TimeSpan.FromSeconds(1.5),
TimeSpan.FromSeconds(1.5),
3,
Hemorrhage
);
}
public PlagueBeastBlood(Serial serial) : base(serial)
{
@ -22,69 +23,57 @@ namespace Server.Items
public bool Starting => ItemID == 0x122C;
public override void OnAfterDelete()
{
if (m_Timer?.Running == true)
{
m_Timer.Stop();
}
}
public override bool OnBandage(Mobile from)
{
if (IsAccessibleTo(from) && !Patched)
if (!IsAccessibleTo(from) || Patched)
{
if (m_Timer?.Running == true)
{
m_Timer.Stop();
}
if (Starting)
{
X += 2;
Y -= 9;
if (Organ is PlagueBeastRubbleOrgan)
{
Y -= 5;
}
else if (Organ is PlagueBeastBackupOrgan)
{
X += 7;
}
}
else
{
X -= 4;
Y -= 2;
}
ItemID = 0x1765;
var pack = Owner?.Backpack;
if (pack != null)
{
for (var i = 0; i < pack.Items.Count; i++)
{
if (pack.Items[i] is PlagueBeastMainOrgan main && main.Complete)
{
main.FinishOpening(from);
}
}
}
PublicOverheadMessage(MessageType.Regular, 0x3B2, 1071916); // * You patch up the wound with a bandage *
return true;
return false;
}
return false;
if (Starting)
{
X += 2;
Y -= 9;
switch (Organ)
{
case PlagueBeastRubbleOrgan:
Y -= 5;
break;
case PlagueBeastBackupOrgan:
X += 7;
break;
}
}
else
{
X -= 4;
Y -= 2;
}
ItemID = 0x1765;
var pack = Owner?.Backpack;
if (pack != null)
{
for (var i = 0; i < pack.Items.Count; i++)
{
if (pack.Items[i] is PlagueBeastMainOrgan main && main.Complete)
{
main.FinishOpening(from);
}
}
}
PublicOverheadMessage(MessageType.Regular, 0x3B2, 1071916); // * You patch up the wound with a bandage *
return true;
}
private void Hemorrhage()
{
if (Patched)
if (Deleted || Patched)
{
return;
}

14
Projects/UOContent/Items/Special/Mutation Core/PlagueBeastMutationCore.cs
View file

@ -41,7 +41,13 @@ namespace Server.Items
if (owner != null)
{
Timer.DelayCall(TimeSpan.FromSeconds(1), KillParent, owner);
Timer.StartTimer(TimeSpan.FromSeconds(1),
() =>
{
owner.Unfreeze();
owner.Kill();
}
);
}
return true;
@ -50,12 +56,6 @@ namespace Server.Items
return false;
}
private void KillParent(PlagueBeastLord parent)
{
parent.Unfreeze();
parent.Kill();
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);

52
Projects/UOContent/Items/Special/Mutation Core/PlagueBeastOrgans.cs
View file

@ -6,7 +6,7 @@ namespace Server.Items
{
public class PlagueBeastOrgan : PlagueBeastInnard
{
private Timer m_Timer;
private bool _opening;
public PlagueBeastOrgan(int itemID = 1, int hue = 0) : base(itemID, hue)
{
@ -15,7 +15,7 @@ namespace Server.Items
Movable = false;
Visible = itemID <= 1;
Timer.DelayCall(Initialize);
Timer.StartTimer(Initialize);
}
public PlagueBeastOrgan(Serial serial) : base(serial)
@ -52,9 +52,20 @@ namespace Server.Items
{
if (IsCuttable && IsAccessibleTo(from))
{
if (!Opened && m_Timer == null)
if (!Opened && !_opening)
{
m_Timer = Timer.DelayCall(TimeSpan.FromSeconds(3), FinishOpening, from);
_opening = true;
void Open()
{
_opening = false;
if (!Deleted)
{
FinishOpening(from);
}
}
Timer.StartTimer(TimeSpan.FromSeconds(3), Open);
scissors.PublicOverheadMessage(MessageType.Regular, 0x3B2, 1071897); // You carefully cut into the organ.
return true;
}
@ -65,14 +76,6 @@ namespace Server.Items
return false;
}
public override void OnAfterDelete()
{
if (m_Timer?.Running == true)
{
m_Timer.Stop();
}
}
public virtual bool OnLifted(Mobile from, PlagueBeastComponent c) => c.IsGland || c.IsBrain;
public virtual bool OnDropped(Mobile from, Item item, PlagueBeastComponent to) => false;
@ -80,7 +83,6 @@ namespace Server.Items
public virtual void FinishOpening(Mobile from)
{
Opened = true;
Owner?.PlaySound(0x50);
}
@ -177,8 +179,8 @@ namespace Server.Items
with.PublicOverheadMessage(
MessageType.Regular,
0x3B2,
1071896
); // This is too crude an implement for such a procedure.
1071896 // This is too crude an implement for such a procedure.
);
}
}
@ -314,8 +316,8 @@ namespace Server.Items
from.LocalOverheadMessage(
MessageType.Regular,
0x3B2,
1071901
); // * As you cut the vein, a cloud of poison is expelled from the plague beast's organ, and the plague beast dissolves into a puddle of goo *
1071901 // * As you cut the vein, a cloud of poison is expelled from the plague beast's organ, and the plague beast dissolves into a puddle of goo *
);
from.ApplyPoison(from, Poison.Greater);
from.PlaySound(0x22F);
@ -378,8 +380,8 @@ namespace Server.Items
with.PublicOverheadMessage(
MessageType.Regular,
0x3B2,
1071896
); // This is too crude an implement for such a procedure.
1071896 // This is too crude an implement for such a procedure.
);
}
}
@ -405,7 +407,7 @@ namespace Server.Items
if (to.Hue == 0x1 && m_Gland == null && item is PlagueBeastGland)
{
m_Gland = item;
Timer.DelayCall(TimeSpan.FromSeconds(3), FinishHealing);
Timer.StartTimer(TimeSpan.FromSeconds(3), FinishHealing);
from.SendAsciiMessage(0x3B2, "* You place the healthy gland inside the organ sac *");
item.Movable = false;
@ -435,7 +437,7 @@ namespace Server.Items
Components[i].Hue = 0x6;
}
Timer.DelayCall(TimeSpan.FromSeconds(2), OpenOrgan);
Timer.StartTimer(TimeSpan.FromSeconds(2), OpenOrgan);
}
public void OpenOrgan()
@ -524,8 +526,8 @@ namespace Server.Items
from.LocalOverheadMessage(
MessageType.Regular,
0x34,
1071913
); // You place the organ in the fleshy receptacle near the core.
1071913 // You place the organ in the fleshy receptacle near the core.
);
if (Owner != null)
{
@ -536,8 +538,8 @@ namespace Server.Items
from.LocalOverheadMessage(
MessageType.Regular,
0x34,
1071922
); // The plague beast is still bleeding from open wounds. You must seal any bleeding wounds before the core will open!
1071922 // The plague beast is still bleeding from open wounds. You must seal any bleeding wounds before the core will open!
);
return true;
}
}

29
Projects/UOContent/Items/Special/Mutation Core/PlagueBeastVein.cs
View file

@ -5,7 +5,7 @@ namespace Server.Items
{
public class PlagueBeastVein : PlagueBeastComponent
{
private Timer m_Timer;
private bool _cutting;
public PlagueBeastVein(int itemID, int hue) : base(itemID, hue) => Cut = false;
@ -19,14 +19,15 @@ namespace Server.Items
{
if (IsAccessibleTo(from))
{
if (!Cut && m_Timer == null)
if (!Cut && !_cutting)
{
m_Timer = Timer.DelayCall(TimeSpan.FromSeconds(3), CuttingDone, from);
_cutting = true;
Timer.StartTimer(TimeSpan.FromSeconds(3), () => CuttingDone(from));
scissors.PublicOverheadMessage(
MessageType.Regular,
0x3B2,
1071899
); // You begin cutting through the vein.
1071899 // You begin cutting through the vein.
);
return true;
}
@ -36,26 +37,12 @@ namespace Server.Items
return false;
}
public override void OnAfterDelete()
{
if (m_Timer?.Running == true)
{
m_Timer.Stop();
}
}
private void CuttingDone(Mobile from)
{
_cutting = false;
Cut = true;
if (ItemID == 0x1B1C)
{
ItemID = 0x1B1B;
}
else
{
ItemID = 0x1B1C;
}
ItemID = ItemID == 0x1B1C ? 0x1B1B : 0x1B1C;
Owner?.PlaySound(0x199);