tuwien.auto.calimero.link.medium.RawAckBase Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2023 B. Malinowsky
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module. An
independent module is a module which is not derived from or based on
this library. If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from your
version.
*/
package tuwien.auto.calimero.link.medium;
/**
* Implementation of common functionality for raw acknowledgment frames.
*
* Objects of this type are considered immutable.
*
* @author B. Malinowsky
*/
public abstract class RawAckBase implements RawFrame
{
/**
* Positive acknowledge type.
*
* @see #getAckType()
*/
public static final int ACK = 0xCC;
/**
* Negative acknowledge type.
*
* @see #getAckType()
*/
public static final int NAK = 0x0C;
/**
* Acknowledge type transmitted with this frame.
*/
protected int ack;
public RawAckBase() {}
@Override
public final int getFrameType()
{
return ACK_FRAME;
}
/**
* {@return the acknowledge type transmitted with this frame as unsigned byte}
*/
public final int getAckType()
{
return ack;
}
/**
* {@return a textual representation of this acknowledgment frame information}
*/
@Override
public String toString()
{
return ack == ACK ? "ACK" : "NAK";
}
}