Topshelf.Integrations is a collection of packages that extend the Topshelf Project. These packages handle the boiler plate code necessary for several use cases that we have found very useful for quickly developing small self contained services on Windows.
These use cases include the following:
- Scheduled activities hosted within a Windows Service
- Integration of your preferred IoC Container
These packages solve these problems by integrating the following technologies with Topshelf and providing extensions to quickly integrate them.
- Quartz.NET - Scheduling
- Ninject - IoC Container
These packages are available on Nuget and can be used in any combination desired. The Ninject package is directly integrated with Topshelf, and also has accompanying packages for Quartz.Net project to make it possible to initiate Quartz.NET IJob instances via the container.
To get the package: Install-Package Topshelf.Ninject.Integration
To use Ninject with your Topshelf service, all you need is three lines:
using Ninject.Modules;
using Topshelf;
using Topshelf.Ninject;
...
class Program
{
static void Main()
{
HostFactory.Run(c =>
{
c.UseNinject(new SampleModule()); //Initiates Ninject and consumes Modules
c.Service<SampleService>(s =>
{
//Specifies that Topshelf should delegate to Ninject for construction
s.ConstructUsingNinject();
s.WhenStarted((service, control) => service.Start());
s.WhenStopped((service, control) => service.Stop());
});
});
}
}
To get the package: Install-Package Topshelf.Quartz.Integration
You may schedule any number of Quartz jobs along with your service like this:
using System;
using Quartz;
using Topshelf;
using Topshelf.Quartz;
...
class Program
{
static void Main()
{
HostFactory.Run(c =>
{
c.Service<SampleService>(s =>
{
s.ConstructUsing(() => new SampleService());
s.WhenStarted((service, control) => service.Start());
s.WhenStopped((service, control) => service.Stop());
// Schedule a job to run in the background every 5 seconds.
// The full Quartz Builder framework is available here.
s.ScheduleQuartzJob(q =>
q.WithJob(() =>
JobBuilder.Create<SampleJob>().Build())
.AddTrigger(() =>
TriggerBuilder.Create()
.WithSimpleSchedule(builder => builder
.WithIntervalInSeconds(5)
.RepeatForever())
.Build())
);
});
});
}
}
You can also add and use Quartz calendars like this:
using System;
using Quartz;
using Topshelf;
using Topshelf.Quartz;
...
class Program
{
static void Main()
{
HostFactory.Run(c =>
{
c.Service<SampleService>(s =>
{
s.ConstructUsing(() => new SampleService());
s.WhenStarted((service, control) => service.Start());
s.WhenStopped((service, control) => service.Stop());
// Adding a calendar to the Scheduler
s.ConfigureQuartzScheduler(() => new SchedulerConfigurator()
.WithCalendar(() => new QuartzCalendarConfig("calendarName", GetCalendar()))
);
// Schedule a job to run in the background every 5 seconds.
// Using the calendar specified above in the trigger.
// The full Quartz Builder framework is available here.
s.ScheduleQuartzJob(q =>
q.WithJob(() =>
JobBuilder.Create<SampleJob>().Build())
.AddTrigger(() =>
TriggerBuilder.Create()
.WithSimpleSchedule(builder => builder
.WithIntervalInSeconds(5)
.RepeatForever())
.ModifiedByCalendar("calendarName")
.Build())
);
});
});
}
private static ICalendar GetCalendar()
{
var bankHolidayCalendar = new HolidayCalendar();
bankHolidayCalendar.AddExcludedDate(DateTime.Today.AddDays(1));
return bankHolidayCalendar;
}
}
To get the package: Install-Package Topshelf.Quartz.Ninject.Integration
You may schedule any number of Quartz jobs along with your service like this:
using System;
using Ninject.Modules;
using Quartz;
using Topshelf;
using Topshelf.Ninject;
using Topshelf.Quartz;
using Topshelf.Quartz.Ninject;
...
class Program
{
static void Main()
{
HostFactory.Run(c =>
{
// Topshelf.Ninject :
// Initiates Ninject and consumes Modules
c.UseNinject(new SampleModule());
c.Service<SampleService>(s =>
{
// Topshelf.Ninject :
// Construct service using Ninject
s.ConstructUsingNinject();
s.WhenStarted((service, control) => service.Start());
s.WhenStopped((service, control) => service.Stop());
// Topshelf.Quartz.Ninject :
// Construct IJob instance with Ninject
s.UseNinjectQuartzJobFactory();
// Topshelf.Quartz :
// Schedule a job to run in the background every 5 seconds.
// The full Quartz Builder framework is available here.
s.ScheduleQuartzJob(q =>
q.WithJob(() =>
JobBuilder.Create<SampleJob>().Build())
.AddTrigger(() =>
TriggerBuilder.Create()
.WithSimpleSchedule(builder => builder
.WithIntervalInSeconds(5)
.RepeatForever())
.Build())
);
});
});
}
}
To get the package: Install-Package Topshelf.Quartz.Extensions
You may schedule any number of Quartz jobs along with your service like this:
using System;
using Quartz;
using Topshelf;
using Topshelf.Quartz;
using Topshelf.Quartz.Extensions;
...
class Program
{
static void Main()
{
HostFactory.Run(c =>
{
c.Service<SampleService>(s =>
{
s.WhenStarted((service, control) => service.Start());
s.WhenStopped((service, control) => service.Stop());
// Topshelf.Quartz.Extensions
s.ScheduleQuartzJobs()
// Schedule a job to run in the background every 5 seconds.
.WithSimpleSchedule<SampleJob>(builder => builder.WithIntervalInSeconds(5))
// Schedule a job using a chron schedule.
.WithCronSchedule<SampleJob>("0/5 * * * * ?")
// Schedule jobs using a TriggerBuilder.
.WithTrigger<SampleJob>(() =>
TriggerBuilder.Create().WithSimpleSchedule(builder =>
builder.WithIntervalInSeconds(5))
.WithPriority(5)
.Build());
});
});
}
}