Test your AI Agents with the all-new Agent to Agent Testing Platform.Learn More

How to use OnEnqueueEvent method of Microsoft.Coyote.Actors.EventQueue class

Best Coyote code snippet using Microsoft.Coyote.Actors.EventQueue.OnEnqueueEvent

EventQueue.cs

Source:EventQueue.cs

...96                return enqueueStatus;97            }98            else99            {100                this.OnEnqueueEvent(e, eventGroup, info);101            }102            return enqueueStatus;103        }104        /// <inheritdoc/>105        public (DequeueStatus status, Event e, EventGroup eventGroup, EventInfo info) Dequeue()106        {107            // Try to get the raised event, if there is one. Raised events108            // have priority over the events in the inbox.109            if (this.RaisedEvent != default)110            {111                if (this.IsEventIgnored(this.RaisedEvent.e))112                {113                    // TODO: should the user be able to raise an ignored event?114                    // The raised event is ignored in the current state.115                    this.OnIgnoreEvent(this.RaisedEvent.e, this.RaisedEvent.eventGroup, null);116                    this.RaisedEvent = default;117                }118                else119                {120                    (Event e, EventGroup eventGroup) = this.RaisedEvent;121                    this.RaisedEvent = default;122                    return (DequeueStatus.Raised, e, eventGroup, null);123                }124            }125            lock (this.Queue)126            {127                // Try to dequeue the next event, if there is one.128                var node = this.Queue.First;129                while (node != null)130                {131                    // Iterates through the events in the inbox.132                    if (this.IsEventIgnored(node.Value.e))133                    {134                        // Removes an ignored event.135                        var nextNode = node.Next;136                        this.Queue.Remove(node);137                        this.OnIgnoreEvent(node.Value.e, node.Value.eventGroup, null);138                        node = nextNode;139                        continue;140                    }141                    else if (this.IsEventDeferred(node.Value.e))142                    {143                        // Skips a deferred event.144                        this.OnDeferEvent(node.Value.e, node.Value.eventGroup, null);145                        node = node.Next;146                        continue;147                    }148                    // Found next event that can be dequeued.149                    this.Queue.Remove(node);150                    return (DequeueStatus.Success, node.Value.e, node.Value.eventGroup, null);151                }152                // No event can be dequeued, so check if there is a default event handler.153                if (!this.IsDefaultHandlerAvailable())154                {155                    // There is no default event handler installed, so do not return an event.156                    // Setting IsEventHandlerRunning must happen inside the lock as it needs157                    // to be synchronized with the enqueue and starting a new event handler.158                    this.IsEventHandlerRunning = false;159                    return (DequeueStatus.NotAvailable, null, null, null);160                }161            }162            // TODO: check op-id of default event.163            // A default event handler exists.164            return (DequeueStatus.Default, DefaultEvent.Instance, null, null);165        }166        /// <inheritdoc/>167        public void RaiseEvent(Event e, EventGroup eventGroup = null)168        {169            this.RaisedEvent = (e, eventGroup);170            this.OnRaiseEvent(e, eventGroup, null);171        }172        //// <inheritdoc/>173        public Task<Event> ReceiveEventAsync(Type eventType, Func<Event, bool> predicate = null)174        {175            var eventWaitTypes = new Dictionary<Type, Func<Event, bool>>176            {177                { eventType, predicate }178            };179            return this.ReceiveEventAsync(eventWaitTypes);180        }181        /// <inheritdoc/>182        public Task<Event> ReceiveEventAsync(params Type[] eventTypes)183        {184            var eventWaitTypes = new Dictionary<Type, Func<Event, bool>>();185            foreach (var type in eventTypes)186            {187                eventWaitTypes.Add(type, null);188            }189            return this.ReceiveEventAsync(eventWaitTypes);190        }191        /// <inheritdoc/>192        public Task<Event> ReceiveEventAsync(params Tuple<Type, Func<Event, bool>>[] events)193        {194            var eventWaitTypes = new Dictionary<Type, Func<Event, bool>>();195            foreach (var e in events)196            {197                eventWaitTypes.Add(e.Item1, e.Item2);198            }199            return this.ReceiveEventAsync(eventWaitTypes);200        }201        /// <summary>202        /// Waits for an event to be enqueued based on the conditions defined in the event wait types.203        /// </summary>204        private Task<Event> ReceiveEventAsync(Dictionary<Type, Func<Event, bool>> eventWaitTypes)205        {206            (Event e, EventGroup eventGroup) receivedEvent = default;207            lock (this.Queue)208            {209                var node = this.Queue.First;210                while (node != null)211                {212                    // Dequeue the first event that the caller waits to receive, if there is one in the queue.213                    if (eventWaitTypes.TryGetValue(node.Value.e.GetType(), out Func<Event, bool> predicate) &&214                        (predicate is null || predicate(node.Value.e)))215                    {216                        receivedEvent = node.Value;217                        this.Queue.Remove(node);218                        break;219                    }220                    node = node.Next;221                }222                if (receivedEvent == default)223                {224                    this.ReceiveCompletionSource = new TaskCompletionSource<Event>();225                    this.EventWaitTypes = eventWaitTypes;226                }227            }228            if (receivedEvent == default)229            {230                // Note that EventWaitTypes is racy, so should not be accessed outside231                // the lock, this is why we access eventWaitTypes instead.232                this.OnWaitEvent(eventWaitTypes.Keys);233                return this.ReceiveCompletionSource.Task;234            }235            this.OnReceiveEventWithoutWaiting(receivedEvent.e, receivedEvent.eventGroup, null);236            return Task.FromResult(receivedEvent.e);237        }238        /// <summary>239        /// Checks if the specified event is currently ignored.240        /// </summary>241        [MethodImpl(MethodImplOptions.AggressiveInlining)]242        protected virtual bool IsEventIgnored(Event e) => this.Owner.IsEventIgnored(e);243        /// <summary>244        /// Checks if the specified event is currently deferred.245        /// </summary>246        [MethodImpl(MethodImplOptions.AggressiveInlining)]247        protected virtual bool IsEventDeferred(Event e) => this.Owner.IsEventDeferred(e);248        /// <summary>249        /// Checks if a default handler is currently available.250        /// </summary>251        [MethodImpl(MethodImplOptions.AggressiveInlining)]252        protected virtual bool IsDefaultHandlerAvailable() => this.Owner.IsDefaultHandlerInstalled();253        /// <summary>254        /// Notifies the actor that an event has been enqueued.255        /// </summary>256        [MethodImpl(MethodImplOptions.AggressiveInlining)]257        protected virtual void OnEnqueueEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) =>258            this.Owner.OnEnqueueEvent(e, eventGroup, eventInfo);259        /// <summary>260        /// Notifies the actor that an event has been raised.261        /// </summary>262        [MethodImpl(MethodImplOptions.AggressiveInlining)]263        protected virtual void OnRaiseEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) =>264            this.Owner.OnRaiseEvent(e, eventGroup, eventInfo);265        /// <summary>266        /// Notifies the actor that it is waiting to receive an event of one of the specified types.267        /// </summary>268        [MethodImpl(MethodImplOptions.AggressiveInlining)]269        protected virtual void OnWaitEvent(IEnumerable<Type> eventTypes) => this.Owner.OnWaitEvent(eventTypes);270        /// <summary>271        /// Notifies the actor that an event it was waiting to receive has been enqueued.272        /// </summary>...

TestEventQueue.cs

Source:TestEventQueue.cs

...38        }39        protected override bool IsEventIgnored(Event e) => this.IgnoredEvents.Contains(e.GetType());40        protected override bool IsEventDeferred(Event e) => this.DeferredEvents.Contains(e.GetType());41        protected override bool IsDefaultHandlerAvailable() => this.IsDefaultHandlerInstalled;42        protected override void OnEnqueueEvent(Event e, EventGroup eventGroup, EventInfo eventInfo)43        {44            this.Logger.WriteLine("Enqueued event of type '{0}'.", e.GetType().FullName);45            this.Notify(Notification.EnqueueEvent, e, eventInfo);46        }47        protected override void OnRaiseEvent(Event e, EventGroup eventGroup, EventInfo eventInfo)48        {49            this.Logger.WriteLine("Raised event of type '{0}'.", e.GetType().FullName);50            this.Notify(Notification.RaiseEvent, e, eventInfo);51        }52        protected override void OnWaitEvent(IEnumerable<Type> eventTypes)53        {54            foreach (var type in eventTypes)55            {56                this.Logger.WriteLine("Waits to receive event of type '{0}'.", type.FullName);...

OnEnqueueEvent

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.Coyote;7using Microsoft.Coyote.Actors;8using Microsoft.Coyote.Actors.Timers;9{10    {11        static void Main(string[] args)12        {13            var runtime = RuntimeFactory.Create();14            runtime.RegisterMonitor(typeof(EventQueueMonitor));15            runtime.CreateActor(typeof(MyActor));16            runtime.Start();17        }18    }19    {20        [OnEntry(nameof(InitOnEntry))]21        [OnEventGotoState(typeof(ConfigureEventQueue), typeof(ConfigureEventQueueState))]22        [OnEventGotoState(typeof(StartEventQueue), typeof(StartEventQueueState))]23        class Init : MonitorState { }24        void InitOnEntry()25        {26            this.RaiseGotoStateEvent<ConfigureEventQueue>();27        }28        [OnEntry(nameof(ConfigureEventQueueOnEntry))]29        [OnEventGotoState(typeof(StartEventQueue), typeof(StartEventQueueState))]30        class ConfigureEventQueueState : MonitorState { }31        void ConfigureEventQueueOnEntry()32        {33            this.Assert(this.Runtime is Microsoft.Coyote.Runtime);34            Microsoft.Coyote.Runtime coyoteRuntime = (Microsoft.Coyote.Runtime)this.Runtime;35            coyoteRuntime.EventQueue.OnEnqueueEvent += this.OnEnqueueEvent;36            this.RaiseGotoStateEvent<StartEventQueue>();37        }38        [OnEntry(nameof(StartEventQueueOnEntry))]39        [OnEventGotoState(typeof(StopEventQueue), typeof(StopEventQueueState))]40        class StartEventQueueState : MonitorState { }41        void StartEventQueueOnEntry()42        {43            this.RaiseGotoStateEvent<StopEventQueue>();44        }45        [OnEntry(nameof(StopEventQueueOnEntry))]46        [OnEventGotoState(typeof(StopEventQueue), typeof(StopEventQueueState))]47        class StopEventQueueState : MonitorState { }48        void StopEventQueueOnEntry()49        {50            this.Assert(this.Runtime is Microsoft.Coyote.Runtime);51            Microsoft.Coyote.Runtime coyoteRuntime = (Microsoft.Coyote.Runtime)this.Runtime;52            coyoteRuntime.EventQueue.OnEnqueueEvent -= this.OnEnqueueEvent;53            this.RaiseHaltEvent();54        }55        void OnEnqueueEvent(object sender, Microsoft.Coyote.A

OnEnqueueEvent

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.Coyote.Actors;7using Microsoft.Coyote.Actors.Timers;8{9    {10        protected override async Task OnInitializeAsync(Event initialEvent)11        {12            await this.RegisterTimerAsync("timer1", new MyTimerEvent(), TimeSpan.FromSeconds(2), TimeSpan.FromSeconds(2));13        }14        protected override Task OnEventAsync(Event e)15        {16            if (e is MyTimerEvent)17            {18                this.SendEvent(this.Id, new MyEvent());19                return Task.CompletedTask;20            }21            else if (e is MyEvent)22            {23                Console.WriteLine("Actor1 received MyEvent");24                return Task.CompletedTask;25            }26            {27                return Task.CompletedTask;28            }29        }30    }31}32using System;33using System.Collections.Generic;34using System.Linq;35using System.Text;36using System.Threading.Tasks;37using Microsoft.Coyote.Actors;38using Microsoft.Coyote.Actors.Timers;39{40    {41        protected override async Task OnInitializeAsync(Event initialEvent)42        {43            await this.RegisterTimerAsync("timer1", new MyTimerEvent(), TimeSpan.FromSeconds(2), TimeSpan.FromSeconds(2));44        }45        protected override Task OnEventAsync(Event e)46        {47            if (e is MyTimerEvent)48            {49                this.SendEvent(this.Id, new MyEvent());50                return Task.CompletedTask;51            }52            else if (e is MyEvent)53            {54                Console.WriteLine("Actor2 received MyEvent");55                return Task.CompletedTask;56            }57            {58                return Task.CompletedTask;59            }60        }61    }62}63using System;64using System.Collections.Generic;65using System.Linq;66using System.Text;67using System.Threading.Tasks;68using Microsoft.Coyote.Actors;69using Microsoft.Coyote.Actors.Timers;70{71    {72        protected override async Task OnInitializeAsync(Event initialEvent)73        {74            await this.RegisterTimerAsync("timer1",

OnEnqueueEvent

Using AI Code Generation

1using System;2using Microsoft.Coyote;3using Microsoft.Coyote.Actors;4{5    {6        static void Main(string[] args)7        {8            EventQueue queue = new EventQueue();9            queue.OnEnqueueEvent += (sender, e) => { Console.WriteLine("Event enqueued"); };10            queue.EnqueueEvent(new Event());11            Console.ReadLine();12        }13    }14}15using System;16using Microsoft.Coyote;17using Microsoft.Coyote.Actors;18{19    {20        static void Main(string[] args)21        {22            EventQueue queue = new EventQueue();23            queue.OnDequeueEvent += (sender, e) => { Console.WriteLine("Event dequeued"); };24            queue.EnqueueEvent(new Event());25            queue.DequeueEvent();26            Console.ReadLine();27        }28    }29}30using System;31using Microsoft.Coyote;32using Microsoft.Coyote.Actors;33{34    {35        static void Main(string[] args)36        {37            ActorRuntime runtime = new ActorRuntime();38            runtime.OnRaiseEvent += (sender, e) => { Console.WriteLine("Event raised"); };39            runtime.SendEvent(new ActorId(), new Event());40            Console.ReadLine();41        }42    }43}44using System;45using Microsoft.Coyote;46using Microsoft.Coyote.Actors;47{48    {49        static void Main(string[] args)50        {51            ActorRuntime runtime = new ActorRuntime();52            runtime.OnSendEvent += (sender, e) => { Console.WriteLine("Event sent"); };53            runtime.SendEvent(new ActorId(), new Event());54            Console.ReadLine();55        }56    }57}58using System;59using Microsoft.Coyote;60using Microsoft.Coyote.Actors;61{62    {63        static void Main(string[] args)64        {

OnEnqueueEvent

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Tasks;6using Microsoft.Coyote.SystematicTesting;7using Microsoft.Coyote.Actors.SystematicTesting;8{9    {10        static void Main(string[] args)11        {12            var runtime = RuntimeFactory.Create();13            var testableRuntime = (TestableRuntime)runtime;14            var eventQueue = new EventQueue();15            testableRuntime.SetEventQueue(eventQueue);16            var actor = new ActorId(1);17            var e = new Event();18            eventQueue.OnEnqueueEvent(actor, e, 0);19        }20    }21}22public void OnEnqueueEvent(ActorId actor, Event e, int groupId)23{24    var wrapper = new EventWrapper(e, groupId, this.IdGenerator.GetNextId());25    this.EnqueueEvent(actor, wrapper);26}27private void EnqueueEvent(ActorId actor, EventWrapper wrapper)28{29    this.Queue.Enqueue(wrapper);30    this.Runtime.NotifyEventEnqueued();31}

OnEnqueueEvent

Using AI Code Generation

1{2    {3        public void OnEnqueueEvent(ActorId actorId, Event e, int queueSize)4        {5        }6    }7}8{9    {10        public void OnEnqueueEvent(ActorId actorId, Event e, int queueSize)11        {12        }13    }14}

OnEnqueueEvent

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote.Actors;4using Microsoft.Coyote.Runtime;5{6    {7        public static void Main(string[] args)8        {9            var runtime = RuntimeFactory.Create();10            runtime.CreateActor(typeof(Actor1));11            Console.ReadLine();12        }13    }14    {15        protected override async Task OnInitializeAsync(Event initialEvent)16        {17            this.OnEnqueueEvent(new Event1());18            await Task.CompletedTask;19        }20    }21    {22    }23}24using System;25using System.Threading.Tasks;26using Microsoft.Coyote.Actors;27using Microsoft.Coyote.Runtime;28{29    {30        public static void Main(string[] args)31        {32            var runtime = RuntimeFactory.Create();33            runtime.CreateActor(typeof(Actor1));34            Console.ReadLine();35        }36    }37    {38        protected override async Task OnInitializeAsync(Event initialEvent)39        {40            this.OnEnqueueEvent(new Event1());41            await Task.CompletedTask;42        }43    }44    {45    }46}47protected override async Task OnInitializeAsync(Event initialEvent)48{49    this.OnEnqueueEvent(new Event1());50    await Task.CompletedTask;51}52runtime.CreateActor(typeof(Actor1));53var runtime = RuntimeFactory.Create();54public void CoyoteTest()55{56    var configuration = Configuration.Create();57    configuration.TestingIterations = 1000;58    configuration.SchedulingIterations = 100;

OnEnqueueEvent

Using AI Code Generation

1using System;2using Microsoft.Coyote.Actors;3using Microsoft.Coyote.Specifications;4using System.Threading.Tasks;5{6    {7        public int Value;8    }9    {10        [OnEventDoAction(typeof(MyEvent), nameof(Handler))]11        {12        }13        private void Handler(Event e)14        {15            var myEvent = (MyEvent)e;16            this.Assert(myEvent.Value == 1, "Expected value is 1.");17        }18    }19    {20        static void Main(string[] args)21        {22            Console.WriteLine("Hello World!");23            var runtime = RuntimeFactory.Create();24            runtime.CreateActor(typeof(MyActor));25            var queue = runtime.GetEventQueue(typeof(MyActor));26            queue.OnEnqueueEvent += (sender, e) =>27            {28                var myEvent = (MyEvent)e;29                Console.WriteLine($"Event enqueued with value {myEvent.Value}.");30            };31            queue.EnqueueEvent(new MyEvent { Value = 1 });32            runtime.Wait();33            Console.WriteLine("Done");34        }35    }36}37using System;38using Microsoft.Coyote.Actors;39using Microsoft.Coyote.Specifications;40using System.Threading.Tasks;41{42    {43        public int Value;44    }45    {46        [OnEventDoAction(typeof(MyEvent), nameof(Handler))]

OnEnqueueEvent

Using AI Code Generation

1{2    {3        {4            OnEnqueueEvent(new E());5        }6    }7}8{9    {10        {11            OnDequeueEvent();12        }13    }14}15{16    {17        {18            OnDequeueEvent();19        }20    }21}22{23    {24        {25            OnDequeueEvent();26        }27    }28}29{30    {31        {32            OnDequeueEvent();33        }34    }35}36{37    {38        {39            OnDequeueEvent();40        }41    }42}

OnEnqueueEvent

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.Coyote.Actors;7using Microsoft.Coyote;8{9    {10        static void Main(string[] args)11        {12            var actor = Actor.Create<Actor1>(new ActorId(1));13            var e = new Event1();14            actor.Runtime.EnqueueEvent(actor.Id, e);15        }16    }17    {18    }19    {20        protected override Task OnInitializeAsync(Event initialEvent)21        {22            return Task.CompletedTask;23        }24        protected override Task OnEventAsync(Event e)25        {26            return Task.CompletedTask;27        }28    }29}30using System;31using System.Collections.Generic;32using System.Linq;33using System.Text;34using System.Threading.Tasks;35using Microsoft.Coyote.Actors;36using Microsoft.Coyote;37{38    {39        static void Main(string[] args)40        {41            var actor = Actor.Create<Actor1>(new ActorId(1));42            var e = new Event1();43            actor.Runtime.EnqueueEvent(actor.Id, e);44        }45    }46    {47    }48    {49        protected override Task OnInitializeAsync(Event initialEvent)50        {51            return Task.CompletedTask;52        }53        protected override Task OnEventAsync(Event e)54        {55            return Task.CompletedTask;

OnEnqueueEvent

Using AI Code Generation

1public class e1 : Event { }2{3    protected override async Task OnInitializeAsync(Event initialEvent)4    {5        this.Runtime.OnEnqueueEvent(new e1());6    }7}8public class e1 : Event { }9{10    protected override async Task OnInitializeAsync(Event initialEvent)11    {12        Event e = this.Runtime.OnDequeueEvent();13    }14}15public class e1 : Event { }16{17    protected override async Task OnInitializeAsync(Event initialEvent)18    {19        Event e = this.Runtime.OnDequeueEvent();20    }21}22public class e1 : Event { }23{24    protected override async Task OnInitializeAsync(Event initialEvent)25    {26        this.Runtime.OnEnqueueEvent(new e1());27    }28}29public class e1 : Event { }30{31    protected override async Task OnInitializeAsync(Event initialEvent)32    {33        this.Runtime.OnEnqueueEvent(new e1());34    }35}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.