core/api/src/main/java/org/onosproject/net/meter/MeterProgrammable.java

/*
 * Copyright 2017-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.meter;

import com.google.common.annotations.Beta;
import org.onosproject.net.driver.HandlerBehaviour;

import java.util.Collection;
import java.util.concurrent.CompletableFuture;

/**
 * Meter programmable device behaviour.
 */
@Beta
public interface MeterProgrammable extends HandlerBehaviour {

    /**
     * Performs a meter operation on this device.
     *
     * @param meterOp operation to be performed
     * @return Completable future with result of the operation
     */
    CompletableFuture<Boolean> performMeterOperation(MeterOperation meterOp);

    /**
     * Queries the meters from the device.
     *
     * @return completable future with the collection of meters
     */
    CompletableFuture<Collection<Meter>> getMeters();

    /**
     * Queries the meter features from the device.
     *
     * @return completable future with the collection of meter features
     */
    CompletableFuture<Collection<MeterFeatures>> getMeterFeatures();
}