/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.openflowplugin.api.openflow.statistics;

import com.google.common.base.Optional;
import com.google.common.util.concurrent.ListenableFuture;
import io.netty.util.Timeout;
import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;

/**
 * Created by Martin Bobak <mbobak@cisco.com> on 27.2.2015.
 */
public interface StatisticsContext extends RequestContextStack, AutoCloseable {

    ListenableFuture<Boolean> gatherDynamicData();

    /**
     * @param pollTimeout handle to nearest scheduled statistics poll
     */
    void setPollTimeout(Timeout pollTimeout);

    /**
     * @return handle to currently scheduled statistics polling
     */
    Optional<Timeout> getPollTimeout();

    /**
     * @return dedicated item life cycle change listener (per device)
     */
    ItemLifecycleListener getItemLifeCycleListener();
}