Improve segmented journal actor metrics
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / client / messages / Shutdown.java
1 /*
2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.cluster.raft.client.messages;
9
10 import akka.dispatch.ControlMessage;
11 import java.io.Serializable;
12
13 /**
14  * Message sent to a raft actor to shutdown gracefully. If it's the leader it will transfer leadership to a
15  * follower. As its last act, the actor self-destructs via a PoisonPill. This message should only be used with
16  * Patterns.gracefulStop().
17  *
18  * @author Thomas Pantelis
19  */
20 public final class Shutdown implements Serializable, ControlMessage {
21     @java.io.Serial
22     private static final long serialVersionUID = 1L;
23
24     public static final Shutdown INSTANCE = new Shutdown();
25
26     private Shutdown() {
27         // Hidden on purpose
28     }
29
30     @java.io.Serial
31     @SuppressWarnings("static-method")
32     private Object readResolve() {
33         return INSTANCE;
34     }
35 }