Windows Service to run constantly

C#Windows Services

C# Problem Overview


I've created a Windows Service called ProxyMonitor and I'm currently at the stage where the service is installs and uninstall's the way I want it.

So I execute the application like so:

C:\\Windows\\Vendor\\ProxyMonitor.exe /install

Pretty self explanatory, and then I got to services.msc and and start the service, but when I do this I get the following message:

> The Proxy Monitor Service on Local Computer started and then stopped. Some services stop automatically if there is no work to do, For example, The performance Logs and Alerts Services

My code looks like so:

public static Main(string[] Args)
{
    if (System.Environment.UserInteractive)
    {
        /*
            * Here I have my install logic
        */
    }
    else
    {
        ServiceBase.Run(new ProxyMonitor());
    }
}

And then within ProxyMonitor class I have:

public ProxyMonitor()
{
}

protected override void OnStart(string[] args)
{
    base.OnStart(args);
    ProxyEventLog.WriteEntry("ProxyMonitor Started");

    running = true;
    while (running)
    {
        //Execution Loop
    }
}

and onStop() I just change the running variable to false;

What would I need to do to make the Service constantly active, as I would need to be monitoring the network I need to trace changes etc.


Update: 1

protected override void OnStart(string[] args)
{
     base.OnStart(args);
     ProxyEventLog.WriteEntry("ProxyMonitor Started");

     Thread = new Thread(ThreadWorker);
     Thread.Start();
 }

Within the ThreadWorker I have ProxyEventLogger.WriteEntry("Main thread entered") which does not get fired.

C# Solutions


Solution 1 - C#

The OnStart() callback needs to return in a timely fashion, so you'll want to kick off a thread where all your work will be performed. I would recommend adding the following fields to your class:

using System.Threading;
private ManualResetEvent _shutdownEvent = new ManualResetEvent(false);
private Thread _thread;

The _thread field will hold a reference to the System.Threading.Thread object you create in the OnStart() callback. The _shutdownEvent field holds a system-level event construct that will be used to signal the thread to stop running on service shutdown.

In the OnStart() callback, create and start your thread.

protected override void OnStart(string[] args)
{
     _thread = new Thread(WorkerThreadFunc);
     _thread.Name = "My Worker Thread";
     _thread.IsBackground = true;
     _thread.Start();
}

You need a function named WorkerThreadFunc in order for this to work. It has to match the System.Threading.ThreadStart delegate signature.

private void WorkerThreadFunc()
{
}

If you don't put anything in this function, the thread will start up and then immediately shutdown, so you have to put some logic in there that basically keeps the thread alive while you do your work. This is where the _shutdownEvent comes in handy.

private void WorkerThreadFunc()
{
    while (!_shutdownEvent.WaitOne(0)) {
        // Replace the Sleep() call with the work you need to do
        Thread.Sleep(1000);
    }
}

The while loop checks the ManualResetEvent to see if it is "set" or not. Since we initialized the object with false above, this check returns false. Inside the loop, we sleep for 1 second. You'll want to replace this with the work you need to do - monitor proxy settings, etc.

Finally, in the OnStop() callback of your Windows Service, you want to signal the thread to stop running. This is easy using the _shutdownEvent.

protected override void OnStop()
{
     _shutdownEvent.Set();
     if (!_thread.Join(3000)) { // give the thread 3 seconds to stop
         _thread.Abort();
     }
} 

Hope this helps.

Solution 2 - C#

You need to exit your OnStart handler in order for the service controller to realize that your service has actually started. To make it work like you want, you could start a timer that ticks at an interval and processes when it ticks.

Edit:

Try putting a System.Diagnostics.Debugger.Launch() in your OnStart to see what is happening (and put a breakpoint in ThreadWorker). I would recommend wrapping this in #if DEBUG to be sure it doesn't get deployed.

I just also realized that you do not give your Thread a name:

 Thread myThread = new Thread(ThreadWorker);
 myThread.Start();

Solution 3 - C#

Sample code demonstrated using a console app. hope this will help..

 class Program
{
    private static CancellationTokenSource _cancellationTokenSource;
    private static ManualResetEvent _shutdownEvent = new ManualResetEvent(false);
    private static Thread _serviceStartThread;
    private static Thread _serviceStopThread;

    private static int workcounter = 0;
    static void Main(string[] args)
    {
       
        _cancellationTokenSource = new CancellationTokenSource();
        _serviceStartThread = new Thread(DoWork);
        _serviceStopThread = new Thread(ScheduledStop);
        StartService();
        StopService();
    }

    private static void StartService()
    {
        _serviceStartThread.Start();

    }

    private static void StopService()
    {
        _serviceStopThread.Start();
    }


    /// <summary>
    /// Triggers a cancellation event for stopping the service in a timely fashion.
    /// </summary>
    private static void ScheduledStop()
    {
        while (!_shutdownEvent.WaitOne(0))
        {
            if (workcounter == 10)
            {
                _cancellationTokenSource.Cancel();
            }
        }
    }

    /// <summary>
    /// Represents a long running Task with cancellation option
    /// </summary>
    private static void DoWork()
    {
        
        while (!_shutdownEvent.WaitOne(0))
        {
            if(!_cancellationTokenSource.Token.IsCancellationRequested)
            {
                workcounter += 1;
                Console.Write(Environment.NewLine);
                Console.Write("Running...counter: " + workcounter.ToString());
                Thread.Sleep(1000);//Not needed, just for demo..
            }
            else
            {
                Console.Write(Environment.NewLine);
                Console.Write("Recieved cancellation token,shutting down in 5 seconds.. counter: " + workcounter.ToString());
                _shutdownEvent.Set();
                Thread.Sleep(5000);//Not needed, just for demo..
            }

        }
    }
}

Solution 4 - C#

Certainly not adding a while loop in the OnStart method. This will say to the OS that the service has not started because it wasn't able to exit safely from the OnStart method. I usually create a Timer that is enabled in the OnStart method. Then in the Ticks method, I do call the necessary method in order to get the applicatin to run.

Alternatively, you can do the following:

// The main entry point for the process 
static void Main() 
{ 
    System.ServiceProcess.ServiceBase[] ServicesToRun; 
    ServicesToRun = new System.ServiceProcess.ServiceBase[] { new WinService1() }; 
    System.ServiceProcess.ServiceBase.Run(ServicesToRun); 
} 

For more information about Windows Services, you can get a skeleton example here.

Solution 5 - C#

Why don't you create a new project in your solution of the type Windows Service? This sets up all the structures you need to implement, including even handlers for service start/stop events.

Solution 6 - C#

In my opinion, the most simplest way to address this issue is:

protected override void OnStart(string[] args)
{            
    new Task(() =>
    {
            new ProxyMonitor();                    
    }).Start();    
}

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionRobertPittView Question on Stackoverflow
Solution 1 - C#Matt DavisView Answer on Stackoverflow
Solution 2 - C#Mark AveniusView Answer on Stackoverflow
Solution 3 - C#Jayesh DhananjayanView Answer on Stackoverflow
Solution 4 - C#Neil KnightView Answer on Stackoverflow
Solution 5 - C#Gabriel MaganaView Answer on Stackoverflow
Solution 6 - C#S.ATTA.MView Answer on Stackoverflow