org.soulwing.snmp.SnmpWalker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tnm4j Show documentation

A simplified SNMP API for Java, inspired by Jürgen Schönwälder's Tnm extension for Tcl.

There is a newer version: 1.2.0

/*
 * tnm4j - Simplified SNMP API for Java
 * Copyright (C) 2012 Carl Harris, Jr
 *
 * 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 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package org.soulwing.snmp;

/**
 * An object that walks a conceptual table.
 *
 * @author Carl Harris
 */
public interface SnmpWalker {

  /**
   * Gets a response representing the next row in the table.
   * 
   * The return value here is never {@code null}.  Instead,
   * the return value from {@link SnmpResponse#get()} will be {@code null} to
   * indicate that the walk has visited all available table rows
   *
   * @return response for next row (never {@code null})
   */
  SnmpResponse next();

}