View Javadoc
1   package org.metricshub.ipmi.core.coding.rmcp;
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.common.TypeConverter;
26  
27  /**
28   * A wrapper class for RMCP message.
29   */
30  public class RmcpMessage {
31  	private RmcpVersion version;
32  	private byte sequenceNumber;
33  	private RmcpClassOfMessage classOfMessage;
34  	private byte[] data;
35  
36  	public RmcpMessage() {
37  		setSequenceNumber(0xff);
38  	}
39  
40  	public void setVersion(RmcpVersion version) {
41  		this.version = version;
42  	}
43  
44  	public RmcpVersion getVersion() {
45  		return version;
46  	}
47  
48  	/**
49  	 * Set RMCP sequence number. Must be 0-254 if ACK is desired, 255 if no ACK is desired.
50  	 *
51  	 * @param sequenceNumber
52  	 */
53  	public void setSequenceNumber(int sequenceNumber) {
54  		this.sequenceNumber = TypeConverter.intToByte(sequenceNumber);
55  	}
56  
57  	public byte getSequenceNumber() {
58  		return sequenceNumber;
59  	}
60  
61  	public int getIntSequenceNumber() {
62  		return TypeConverter.byteToInt(sequenceNumber);
63  	}
64  
65  	public void setClassOfMessage(RmcpClassOfMessage classOfMessage) {
66  		this.classOfMessage = classOfMessage;
67  	}
68  
69  	public RmcpClassOfMessage getClassOfMessage() {
70  		return classOfMessage;
71  	}
72  
73  	public void setData(byte[] data) {
74  		this.data = data;
75  	}
76  
77  	public byte[] getData() {
78  		return data;
79  	}
80  }