uk.co.westhawk.snmp.event.DecodedPduEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp Show documentation
SNMP Client Library for Java
The newest version!
// NAME
//      $RCSfile: DecodedPduEvent.java,v $
// DESCRIPTION
//      [given below in javadoc format]
// DELTA
//      $Revision: 1.5 $
// CREATED
//      $Date: 2006/02/09 14:30:18 $
// COPYRIGHT
//      Westhawk Ltd
// TO DO
//

/*
 * Copyright (C) 2005 - 2006 by Westhawk Ltd
 * www.westhawk.co.uk
 *
 * Permission to use, copy, modify, and distribute this software
 * for any purpose and without fee is hereby granted, provided
 * that the above copyright notices appear in all copies and that
 * both the copyright notice and this permission notice appear in
 * supporting documentation.
 * This software is provided "as is" without express or implied
 * warranty.
 * author Tim Panton
 */
package uk.co.westhawk.snmp.event;

/*-
 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
 * SNMP Java Client
 * ჻჻჻჻჻჻
 * Copyright 2023 Sentry Software, Westhawk
 * ჻჻჻჻჻჻
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 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 Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
 */

import uk.co.westhawk.snmp.stack.*;


/**
 * The DecodedPduEvent class. This class is delivered when a pdu is received.
 *
 * @since 4_14
 * @author Birgit Arkesteijn
 * @version $Revision: 1.5 $ $Date: 2006/02/09 14:30:18 $
 */
public abstract class DecodedPduEvent extends java.util.EventObject  
{
    private static final String     version_id =
        "@(#)$Id: DecodedPduEvent.java,v 1.5 2006/02/09 14:30:18 birgit Exp $ Copyright Westhawk Ltd";

    protected boolean consumed = false;

    private int hostPort = -1;
    private Pdu pdu;

/** 
 * The constructor for a decoded pdu event. The SnmpContext classes
 * will fire decoded pdu events.
 *
 * @param source The source (SnmpContext) of the event
 * @param p The pdu
 * @param prt The remote port number of the host where the pdu came from
 *
 * @see #getHostPort()
 * @see #getPdu()
 */
public DecodedPduEvent(Object source, Pdu p, int prt) 
{
    super(source);
    pdu = p;
    hostPort = prt;
}



/**
 * The remote port number of the host where the pdu came from. 
 *
 * @return The remote port number of the host or -1.
 *
 */
public int getHostPort()
{
    return hostPort;
}


/**
 * The pdu. The pdu is part of a decoded pdu event.
 *
 * @return The decoded Pdu.
 */
public Pdu getPdu()
{
    return pdu;
}

/**
 * Consumes this event so that it will not be sent to any other
 * listeners.
 */
public void consume()
{
    consumed = true;
}

/**
 * Returns whether or not this event has been consumed.
 * @see #consume 
 */
public boolean isConsumed()
{
    return consumed;
}

}