tuwien.auto.calimero.cemi.CEMI Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2005 B. Erb
Copyright (c) 2006, 2021 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.cemi;
import tuwien.auto.calimero.ServiceType;
/**
* Common External Message Interface (cEMI).
*
* Acts as basic interface to the cEMI abstract data type.
* The cEMI message format aims to be a frame structure for KNX information transport,
* independent of various KNX media.
*
* @author Bernhard Erb
* @author B. Malinowsky
*/
public interface CEMI extends ServiceType
{
/**
* Returns the payload carried in this cEMI message.
*
* In general, the payload refers to that content of a cEMI frame, which is not
* interpreted nor parsed by the different types of cEMI. See the corresponding
* subtypes for a more specific description.
*
* @return subset of frame data as byte array
*/
byte[] getPayload();
/**
* Returns the cEMI message code.
*
* The codes of the different cEMI message types can be looked up in the according
* subtype implementations.
*
* @return the message code as unsigned byte
*/
int getMessageCode();
/**
* Returns the length of this cEMI message frame.
*
*
* @return the message length in bytes
*/
int getStructLength();
/**
* Returns the length of this cEMI message frame.
*
* @return the message length in bytes
*/
@Override
default int length() { return getStructLength(); }
/**
* Returns the byte representation of the whole cEMI message structure.
*
* @return frame as byte array
*/
@Override
byte[] toByteArray();
}