1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http.nio.command;
29
30 import org.apache.hc.core5.function.Callback;
31 import org.apache.hc.core5.io.CloseMode;
32 import org.apache.hc.core5.reactor.Command;
33 import org.apache.hc.core5.reactor.IOSession;
34
35 /**
36 * Shutdown command. Two shutdown modes are supported: {@link CloseMode#GRACEFUL} and
37 * {@link CloseMode#IMMEDIATE}. The exact implementation of both modes is protocol or handler
38 * specific.
39 *
40 * @since 5.0
41 */
42 public final class ShutdownCommand implements Command {
43
44 public static final ShutdownCommand GRACEFUL = new ShutdownCommand(CloseMode.GRACEFUL);
45 public static final ShutdownCommand IMMEDIATE = new ShutdownCommand(CloseMode.IMMEDIATE);
46
47 public static final Callback<IOSession> GRACEFUL_IMMEDIATE_CALLBACK = createIOSessionCallback(Priority.IMMEDIATE);
48 public static final Callback<IOSession> GRACEFUL_NORMAL_CALLBACK = createIOSessionCallback(Priority.NORMAL);
49
50 private static Callback<IOSession> createIOSessionCallback(final Priority priority) {
51 return session -> session.enqueue(ShutdownCommand.GRACEFUL, priority);
52 }
53
54 private final CloseMode type;
55
56 public ShutdownCommand(final CloseMode type) {
57 this.type = type;
58 }
59
60 public CloseMode getType() {
61 return type;
62 }
63
64 @Override
65 public boolean cancel() {
66 return true;
67 }
68
69 @Override
70 public String toString() {
71 return "Shutdown: " + type;
72 }
73
74 }