Skip to main content
summaryrefslogtreecommitdiffstats
blob: 66b7ef1ef2c5f592b97e876468a43eece804a961 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright (c) 2008, 2010-2013 Eike Stepper (Berlin, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Eike Stepper - initial API and implementation
 */
package org.eclipse.net4j.util.concurrent;

import org.eclipse.net4j.util.lifecycle.LifecycleState;

import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;

/**
 * @author Eike Stepper
 * @since 2.0
 */
public abstract class QueueWorker<E> extends Worker
{
  /**
   * @since 3.2
   */
  public static final int DEFAULT_POLL_MILLIS = 100;

  private BlockingQueue<E> queue = createQueue();

  private long pollMillis;

  public QueueWorker()
  {
    setPollMillis(DEFAULT_POLL_MILLIS);
  }

  public long getPollMillis()
  {
    return pollMillis;
  }

  public void setPollMillis(long pollMillis)
  {
    this.pollMillis = pollMillis;
  }

  /**
   * @since 3.0
   */
  public void clearQueue()
  {
    if (queue != null)
    {
      queue.clear();
    }
  }

  public boolean addWork(E element)
  {
    if (queue != null && getLifecycleState() != LifecycleState.DEACTIVATING)
    {
      return queue.offer(element);
    }

    return false;
  }

  @Override
  protected void work(WorkContext context) throws Exception
  {
    doWork(context);
  }

  private void doWork(WorkContext context) throws InterruptedException
  {
    E element = pollQueue();
    if (element != null)
    {
      work(context, element);
    }
    else
    {
      noWork(context);
    }
  }

  /**
   * Factored out for better profiling.
   */
  private E pollQueue() throws InterruptedException
  {
    return queue.poll(pollMillis, TimeUnit.MILLISECONDS);
  }

  protected abstract void work(WorkContext context, E element);

  /**
   * @since 3.3
   */
  protected void noWork(WorkContext context)
  {
  }

  protected BlockingQueue<E> createQueue()
  {
    return new LinkedBlockingQueue<E>();
  }

  /**
   * @since 3.1
   */
  protected boolean doRemainingWorkBeforeDeactivate()
  {
    return false;
  }

  @Override
  protected void doDeactivate() throws Exception
  {
    super.doDeactivate();
    if (queue != null)
    {
      if (doRemainingWorkBeforeDeactivate())
      {
        WorkContext context = new WorkContext();
        while (!queue.isEmpty())
        {
          doWork(context);
        }
      }
      else
      {
        queue.clear();
      }
    }
  }
}

Back to the top