1 /*
2 * Copyright 2019 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.channel;
17
18 import java.util.Queue;
19
20 /**
21 * Factory used to create {@link Queue} instances that will be used to store tasks for an {@link EventLoop}.
22 *
23 * Generally speaking the returned {@link Queue} MUST be thread-safe and depending on the {@link EventLoop}
24 * implementation must be of type {@link java.util.concurrent.BlockingQueue}.
25 */
26 public interface EventLoopTaskQueueFactory {
27
28 /**
29 * Returns a new {@link Queue} to use.
30 * @param maxCapacity the maximum amount of elements that can be stored in the {@link Queue} at a given point
31 * in time.
32 * @return the new queue.
33 */
34 Queue<Runnable> newTaskQueue(int maxCapacity);
35 }