Free cookie consent management tool by TermsFeed Policy Generator

source: branches/HeuristicLab.Hive-3.4/sources/HeuristicLab.Clients.Hive.Slave/3.4/MessageQueue.cs @ 5137

Last change on this file since 5137 was 5105, checked in by ascheibe, 14 years ago

ported most of the slave code to 3.4 #1233

File size: 3.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Threading;
25using HeuristicLab.Services.Hive.Common;
26
27namespace HeuristicLab.Clients.Hive.Salve {
28
29  /// <summary>
30  /// Queue for the communication between threads and AppDomains. The Queue is threadsafe and uses a semaphore
31  /// </summary>
32  public class MessageQueue : MarshalByRefObject {
33
34    private static MessageQueue instance = null;
35   
36    private Queue<MessageContainer> queue = null;
37    private Semaphore semaphore = null;                 
38
39    /// <summary>
40    /// Returns the Instance of the MessageQueue. If the instance is null, it will be created.
41    /// This is a Implementation of the Singleton pattern
42    /// </summary>
43    /// <returns>the MessageQueue Instance</returns>
44    public static MessageQueue GetInstance() {
45      if (instance == null) {
46        instance = new MessageQueue();
47      }
48      return instance;
49    }
50
51    /// <summary>
52    /// Sets Lease time to infinite
53    /// </summary>
54    /// <returns>nothing</returns>
55    public override object InitializeLifetimeService() {
56      return null;
57    }
58
59    /// <summary>
60    /// Creates a new MessageQueue Object.
61    /// A new Queue and a Semaphore is created. The Semaphore is set to a max size of 5000.
62    /// </summary>
63    private MessageQueue() {
64      queue = new Queue<MessageContainer>();
65      semaphore = new Semaphore(0, 5000);
66    }
67
68    /// <summary>
69    /// Returns the oldest MessageContainer Object from the Queue.
70    /// </summary>
71    /// <returns>the oldest MessageContainer Object</returns>
72    public MessageContainer GetMessage() {
73      semaphore.WaitOne();
74      lock (this) {
75        if (queue.Count > 0) {
76          return queue.Dequeue();
77        }
78      }
79      return null;
80    }
81
82    /// <summary>
83    /// Adds a MessageContainer Object to the Queue
84    /// </summary>
85    /// <param name="messageContainer">the MessageContainer</param>
86    public void AddMessage(MessageContainer messageContainer) {
87      lock (this) {
88        queue.Enqueue(messageContainer);
89        semaphore.Release();
90      }
91    }
92
93    /// <summary>
94    /// Adds a message to the Queue. The MessageContainer Object is built in the Method
95    /// </summary>
96    /// <param name="message">the Message</param>
97    public void AddMessage(MessageContainer.MessageType message) {
98      lock (this) {
99        queue.Enqueue(new MessageContainer(message));
100        semaphore.Release();
101      }
102    }
103  }
104}
Note: See TracBrowser for help on using the repository browser.