Skip to content

/Itinerary forked from spoulson/Itinerary

Lazy time scheduling toolset for .NET
  1. C# 100.0%
C#
Find file
Download ZIP
Pull request Compare This branch is 1 commit ahead, 2 commits behind spoulson:master.
Latest commit 976846c @SaintPeter Fixed Last DOW Occurance Calculation for conditions not caught by the… 
… original code:

1) When the first DOW does not occur in the first week of the month
2) When the last DOW does not occur in the last week of the month
Failed to load latest commit information.
Examples Implemented two simple example projects.
Expl.Itinerary.Parser Implemented 'beginning'/'end' keywords in TDL grammar for OneTimeSche…
Expl.Itinerary.Quartz Accidentally left some unit tests commented out from prior troublesho…
Expl.Itinerary Fixed Last DOW Occurance Calculation for conditions not caught by the…
Itinerary unit tests Fixed Last DOW Occurance Calculation for conditions not caught by the…
TDL Explorer Slight optimization to TDL Parser tool.
.gitignore Implemented two simple example projects.
Itinerary.sln Implemented two simple example projects.
Itinerary.vsmdi First working version 1.0.
Local.testsettings First working version 1.0.
README.markdown README update.
TraceAndTestImpact.testsettings First working version 1.0.

README.markdown

Itinerary: Lazy time scheduling toolset for .NET

Release 1.0, 2011-06-23
GitHub repo: https://github.com/spoulson/Itinerary
Shawn Poulson, http://explodingcoder.com

INTRODUCTION

What does Itinerary do?

  • Describe an abstract schedule of timed events as an expression, such as the equivalent of:
    "Every Friday at 5:30 pm for 1 hour, except on holidays", for any given time range.
  • Parse expressions to an Itinerary ISchedule object at runtime.
  • ISchedule provides IEnumerable of timed events within any given time range.
  • Perform complex boolean set math on schedules.
  • Change ISchedule properties programmatically, then reserialize back to TDL expression string.

What doesn't Itinerary do?

  • Does not actively run tasks on a schedule. That's your job.
    For that, check out Quartz.NET and the ItineraryTrigger class in the solution.
  • Does not perform timezone interpretation or computation. All date/times are timezone agnostic.

Why use Itinerary?

  • Lightweight, stateless, lazily generate events on demand.
  • You need to integrate a cron-like scheduler into your app.
  • You already use a scheduler, like Quartz.NET, but need more powerful scheduling logic.
  • You need to logically describe arbitrary or complex recurrance patterns.
  • You need to forecast scheduled timed events.
  • You need to store the recurrance logic (not the events) for later reuse.

How do I get started using Itinerary?

  • Learn TDL expression syntax from the Itinerary Wiki on GitHub: https://github.com/spoulson/Itinerary/wiki
  • Test TDL expression syntax using the TDL Explorer tool in the solution.
  • Check out the example projects.
  • Refer to unit tests for usage reference.

SYSTEM REQUIREMENTS

Development requirements:

  • Visual Studio 2010 (Professional edition or better required for unit test execution).
  • Java SE JDK (optional, required to recompile ANTLR grammar).
  • Expl.Itinerary.Quartz project includes Quartz 1.0.3 and Common.Logging 2.0. You may need to update references depending on your requirements.

Runtime requirements:

  • .NET 4.0 Framework.

KNOWN ISSUES

None reported at time of release.
See GitHub repo for issue tracking.

LICENSING

Itinerary is an open source project licensed under the Creative Commons Attribution license: http://creativecommons.org/licenses/by/3.0/legalcode.

ANTLR 3.2 http://antlr.org binary tools and .NET runtime are included in the Expl.Itinerary.Parser project, allowable under ANTLR's BSD license terms: http://antlr.org/license.html.

Something went wrong with that request. Please try again.