1 package org.metricshub.ipmi.core.sm.states;
2
3 /*-
4 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5 * IPMI Java Client
6 * ჻჻჻჻჻჻
7 * Copyright 2023 Verax Systems, MetricsHub
8 * ჻჻჻჻჻჻
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation, either version 3 of the
12 * License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Lesser Public License for more details.
18 *
19 * You should have received a copy of the GNU General Lesser Public
20 * License along with this program. If not, see
21 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23 */
24
25 import org.metricshub.ipmi.core.coding.rmcp.RmcpMessage;
26 import org.metricshub.ipmi.core.sm.StateMachine;
27 import org.metricshub.ipmi.core.sm.events.StateMachineEvent;
28
29 /**
30 * The abstract for state of the {@link StateMachine}.
31 */
32 public abstract class State {
33 /**
34 * Defines the action performed when the state is entered.
35 *
36 * @param stateMachine
37 * - the context
38 */
39 public void onEnter(StateMachine stateMachine) {}
40
41 /**
42 * Performs the state transition
43 *
44 * @param stateMachine
45 * - the context
46 * @param machineEvent
47 * - the {@link StateMachineEvent} that was the cause of the
48 * transition
49 */
50 public abstract void doTransition(StateMachine stateMachine, StateMachineEvent machineEvent);
51
52 /**
53 * Defines the action that should be performed when a response form the
54 * remote system arrives in the current state.
55 *
56 * @param stateMachine
57 * - the context
58 * @param message
59 * - the message that appeared
60 */
61 public abstract void doAction(StateMachine stateMachine, RmcpMessage message);
62 }