core/api/src/main/java/org/onosproject/net/behaviour/TableStatisticsDiscovery.java

/*
 * Copyright 2018-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.net.behaviour;

import org.onosproject.net.driver.HandlerBehaviour;
import org.onosproject.net.flow.TableStatisticsEntry;
import java.util.Collection;

/**
 * Behaviour capable of retrieving table statistics from device.
 */
public interface TableStatisticsDiscovery extends HandlerBehaviour {

    /**
     * Returns statistics for all match-action tables currently defined by the device forwarding pipeline.
     *
     * @return a list of tableStatisticEntry
     */
    Collection<TableStatisticsEntry> getTableStatistics();

}