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

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

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

EventQueue.cs

Source:EventQueue.cs

...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>273        [MethodImpl(MethodImplOptions.AggressiveInlining)]274        protected virtual void OnReceiveEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) =>275            this.Owner.OnReceiveEvent(e, eventGroup, eventInfo);276        /// <summary>277        /// Notifies the actor that an event it was waiting to receive was already in the278        /// event queue when the actor invoked the receive statement.279        /// </summary>280        [MethodImpl(MethodImplOptions.AggressiveInlining)]281        protected virtual void OnReceiveEventWithoutWaiting(Event e, EventGroup eventGroup, EventInfo eventInfo) =>282            this.Owner.OnReceiveEventWithoutWaiting(e, eventGroup, eventInfo);283        /// <summary>284        /// Notifies the actor that an event has been ignored.285        /// </summary>286        [MethodImpl(MethodImplOptions.AggressiveInlining)]287        protected virtual void OnIgnoreEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) => this.Owner.OnIgnoreEvent(e);288        /// <summary>289        /// Notifies the actor that an event has been deferred.290        /// </summary>291        [MethodImpl(MethodImplOptions.AggressiveInlining)]292        protected virtual void OnDeferEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) => this.Owner.OnDeferEvent(e);293        /// <summary>294        /// Notifies the actor that an event has been dropped.295        /// </summary>296        [MethodImpl(MethodImplOptions.AggressiveInlining)]297        protected virtual void OnDropEvent(Event e, EventGroup eventGroup, EventInfo eventInfo) =>298            this.Owner.OnDropEvent(e, eventInfo);299        //// <inheritdoc/>300        public int GetCachedState() => 0;301        /// <inheritdoc/>...

TestEventQueue.cs

Source:TestEventQueue.cs

...66        {67            this.Logger.WriteLine("Received event of type '{0}' without waiting.", e.GetType().FullName);68            this.Notify(Notification.ReceiveEventWithoutWaiting, e, eventInfo);69        }70        protected override void OnIgnoreEvent(Event e, EventGroup eventGroup, EventInfo eventInfo)71        {72            this.Logger.WriteLine("Ignored event of type '{0}'.", e.GetType().FullName);73            this.Notify(Notification.IgnoreEvent, e, eventInfo);74        }75        protected override void OnDeferEvent(Event e, EventGroup eventGroup, EventInfo eventInfo)76        {77            this.Logger.WriteLine("Deferred event of type '{0}'.", e.GetType().FullName);78            this.Notify(Notification.DeferEvent, e, eventInfo);79        }80        protected override void OnDropEvent(Event e, EventGroup eventGroup, EventInfo eventInfo)81        {82            this.Logger.WriteLine("Dropped event of type '{0}'.", e.GetType().FullName);83            this.Notify(Notification.DropEvent, e, eventInfo);84        }...

OnIgnoreEvent

Using AI Code Generation

1using System;2using System.Threading.Tasks;3using Microsoft.Coyote;4using Microsoft.Coyote.Actors;5using Microsoft.Coyote.Actors.Timers;6using Microsoft.Coyote.Specifications;7{8    {9        static void Main(string[] args)10        {11            var runtime = RuntimeFactory.Create();12            var actor = runtime.CreateActor(typeof(MyActor));13            runtime.SendEvent(actor, new MyEvent());14            runtime.Wait();15        }16    }17    {18        protected override async Task OnInitializeAsync(Event initialEvent)19        {20            this.RegisterEventHandler<MyEvent>(this.OnMyEvent);21            this.RegisterEventHandler<MyOtherEvent>(this.OnMyOtherEvent);22            this.RegisterEventHandler<MyTimerEvent>(this.OnMyTimerEvent);23            this.RegisterTimer("MyTimer", new MyTimerEvent(), 100, 100);24            await this.ReceiveEventAsync<MyEvent>();25            await this.ReceiveEventAsync<MyOtherEvent>();26            await this.ReceiveEventAsync<MyTimerEvent>();27            await this.ReceiveEventAsync<MyEvent, MyOtherEvent>();28            await this.ReceiveEventAsync<MyEvent, MyOtherEvent>();29            await this.ReceiveEventAsync<MyEvent, MyOtherEvent, MyTimerEvent>();30            await this.ReceiveEventAsync<MyEvent, MyOtherEvent, MyTimerEvent>();31            await this.ReceiveEventAsync<MyEvent, MyOtherEvent, MyTimerEvent>();

OnIgnoreEvent

Using AI Code Generation

1{2    static void Main(string[] args)3    {4        var config = Configuration.Create().WithVerbosityEnabled();5        using (var runtime = RuntimeFactory.Create(config))6        {7            var actor = runtime.CreateActor(typeof(MyActor));8            Console.WriteLine(runtime.GetMonitorStatus());9            runtime.SendEvent(actor, new Event1());10            runtime.SendEvent(actor, new Event2());11            runtime.SendEvent(actor, new Event1());12            runtime.SendEvent(actor, new Event2());13            runtime.SendEvent(actor, new Event1());14            runtime.SendEvent(actor, new Event2());15            Console.WriteLine(runtime.GetMonitorStatus());16        }17    }18}19{20    static void Main(string[] args)21    {22        var config = Configuration.Create().WithVerbosityEnabled();23        using (var runtime = RuntimeFactory.Create(config))24        {25            var actor = runtime.CreateActor(typeof(MyActor));26            Console.WriteLine(runtime.GetMonitorStatus());27            runtime.SendEvent(actor, new Event1());28            runtime.SendEvent(actor, new Event2());29            runtime.SendEvent(actor, new Event1());30            runtime.SendEvent(actor, new Event2());31            runtime.SendEvent(actor, new Event1());32            runtime.SendEvent(actor, new Event2());33            Console.WriteLine(runtime.GetMonitorStatus());34        }35    }36}37{38    static void Main(string[] args)39    {40        var config = Configuration.Create().WithVerbosityEnabled();41        using (var runtime = RuntimeFactory.Create(config))42        {43            var actor = runtime.CreateActor(typeof(MyActor));44            Console.WriteLine(runtime.GetMonitorStatus());45            runtime.SendEvent(actor, new Event1());46            runtime.SendEvent(actor, new Event2());47            runtime.SendEvent(actor, new Event1());48            runtime.SendEvent(actor, new Event2());49            runtime.SendEvent(actor, new

OnIgnoreEvent

Using AI Code Generation

1using Microsoft.Coyote.Actors;2using System;3using System.Threading.Tasks;4{5    {6        public static void Main()7        {8            var config = Configuration.Create().WithVerbosityEnabled();9            var runtime = RuntimeFactory.Create(config);10            runtime.RegisterOnIgnoreEvent(OnIgnoreEvent);11            var task = Task.Run(() => runtime.CreateActor(typeof(Actor1)));12            task.Wait();13        }14        private static void OnIgnoreEvent(Event e)15        {16            Console.WriteLine($"Ignored event {e}");17        }18    }19    {20        [OnEntry(nameof(InitOnEntry))]21        [OnEventDoAction(typeof(Event1), nameof(HandleEvent1))]22        private class Init : State { }23        private void InitOnEntry()24        {25            this.SendEvent(this.Id, new Event1());26            this.SendEvent(this.Id, new Event2());27        }28        private void HandleEvent1()29        {30            this.RaiseHaltEvent();31        }32    }33    public class Event1 : Event { }34    public class Event2 : Event { }35}36using Microsoft.Coyote.Actors;37using System;38using System.Threading.Tasks;39{40    {41        public static void Main()42        {43            var config = Configuration.Create().WithVerbosityEnabled();44            var runtime = RuntimeFactory.Create(config);45            var task = Task.Run(() => runtime.CreateActor(typeof(Actor1)));46            task.Wait();47        }48    }49    {

OnIgnoreEvent

Using AI Code Generation

1{2    protected override Task OnInitializeAsync(Event initialEvent)3    {4        this.SendEvent(this.Id, new Event1());5        return Task.CompletedTask;6    }7    protected override Task OnEventAsync(Event e)8    {9        if (e is Event1)10        {11            this.SendEvent(this.Id, new Event2());12            this.SendEvent(this.Id, new Event3());13        }14        else if (e is Event2)15        {16            this.SendEvent(this.Id, new Event4());17        }18        else if (e is Event3)19        {20            this.SendEvent(this.Id, new Event5());21        }22        else if (e is Event4)23        {24            this.SendEvent(this.Id, new Event6());25        }26        else if (e is Event5)27        {28            this.SendEvent(this.Id, new Event6());29        }30        else if (e is Event6)31        {32            this.SendEvent(this.Id, new Event2());33        }34        return Task.CompletedTask;35    }36}37{38    static void Main(string[] args)39    {40        var runtime = RuntimeFactory.Create();41        runtime.CreateActor(typeof(Actor1));42        runtime.Run();43    }44}45{46    protected override Task OnInitializeAsync(Event initialEvent)47    {48        this.SendEvent(this.Id, new Event1());49        return Task.CompletedTask;50    }51    protected override Task OnEventAsync(Event e)52    {53        if (e is Event1)54        {55            this.SendEvent(this.Id, new Event2());56            this.SendEvent(this.Id, new Event3());57        }58        else if (e is Event2)59        {60            this.SendEvent(this.Id, new Event4());61        }62        else if (e is Event3)63        {64            this.SendEvent(this.Id, new Event5());65        }66        else if (e is Event4)67        {68            this.SendEvent(this.Id, new Event6());69        }70        else if (e is Event5)71        {72            this.SendEvent(this.Id, new Event6());73        }74        else if (e is Event6)75        {76            this.SendEvent(this.Id, new Event2());77        }78        return Task.CompletedTask;79    }80    protected override void OnIgnoreEvent(Event

OnIgnoreEvent

Using AI Code Generation

1using System;2using Microsoft.Coyote.Actors;3using Microsoft.Coyote.Runtime;4using Microsoft.Coyote.Testing;5using Microsoft.Coyote.TestingServices;6using Microsoft.Coyote.Tasks;7using Microsoft.Coyote.SystematicTesting;8using Microsoft.Coyote.SystematicTesting.Strategies;9using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration;10using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies;11using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing;12using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Config;13using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers;14using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.DPOR;15using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.Fair;16using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.Random;17using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.RandomWalk;18using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.RoundRobin;19using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace;20using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Config;21using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search;22using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search.Config;23using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search.Heuristics;24using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search.Heuristics.Config;25using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search.Heuristics.Coverage;26using Microsoft.Coyote.SystematicTesting.Strategies.ScheduleExploration.Strategies.Fuzzing.Schedulers.StateSpace.Search.Heuristics.Coverage.Config;

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.