tuwien.auto.calimero.knxnetip.LostMessageEvent Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2011 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.knxnetip;
import java.net.InetSocketAddress;
import java.util.EventObject;
import tuwien.auto.calimero.knxnetip.servicetype.RoutingLostMessage;
/**
* Event informing about an overflow with loss of messages in KNXnet/IP routing mode.
*
* It contains lost message and device state information on overflow of the LAN-to-KNX
* queue in the KNXnet/IP router, which leads to loss of received KNXnet/IP messages. This
* event is multicasted by the KNXnet/IP router every time an increment in lost messages
* occurs. In the router, the number of lost messages is maintained in the
* PID.QUEUE_OVERFLOW_TO_KNX property value.
* The lost message value states the total of lost messages in the router.
*
* @author B. Malinowsky
* @see KNXnetIPRouting
*/
public class LostMessageEvent extends EventObject
{
private static final long serialVersionUID = 1L;
private final InetSocketAddress from;
private final int state;
private final int lost;
/**
* Creates a new routing lost message event.
*
*
* @param source the {@link KNXnetIPRouting} which received a routing lost message
* {@link RoutingLostMessage} notification and created this event
* @param sender address of the KNXnet/IP router which lost a message and sent a lost
* message notification
* @param deviceState KNXnet/IP router device state, 0 <= state <= 255
* @param lostMessages number of lost messages, 0 <= number <= 0xFFFF
*/
public LostMessageEvent(final KNXnetIPRouting source, final InetSocketAddress sender,
final int deviceState, final int lostMessages)
{
super(source);
from = sender;
state = deviceState;
lost = lostMessages;
}
/**
* Returns the sender address of the KNXnet/IP router which sent the routing lost
* message notification.
*
* @return socket address of sender
*/
public final InetSocketAddress getSender()
{
return from;
}
/**
* Returns the total of lost messages maintained by the KNXnet/IP routing device.
*
*
* @return number of lost messages as unsigned 16 bit value
*/
public final int getLostMessages()
{
return lost;
}
/**
* Returns the router device state.
*
* The device state is a bit field with 8 Bits and conforms to the
* PID.KNXNETIP_DEVICE_STATE property value.
*
* @return device state as unsigned byte
*/
public final int getDeviceState()
{
return state;
}
/**
* Returns whether the KNX network cannot be accessed, causing the message loss.
*
* The KNX fault mode is part of the device state.
*
* @return true on KNX access fault, false otherwise
* @see #getDeviceState()
*/
public final boolean isKNXFault()
{
return (state & 0x01) != 0;
}
}