api/src/main/java/org/opencord/igmpproxy/IgmpStatisticsService.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.opencord.igmpproxy;

import org.onosproject.event.ListenerService;

/**
 * Service for interacting with accounting module.
 */
public interface IgmpStatisticsService extends
        ListenerService<IgmpStatisticsEvent, IgmpStatisticsEventListener> {

    /**
     * Increases statistic-value for given type.
     *
     * @param type type of igmp-statistic.
     */
    void increaseStat(IgmpStatisticType type);

    /**
     * Resets all statistic-values.
     */
    void resetAllStats();

    /**
     * Get statistic-value for given type.
     *
     * @param type type of igmp-statistic
     * @return value of statistic
     */
    Long getStat(IgmpStatisticType type);

}