openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/statistics/StatisticsContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.openflowplugin.api.openflow.statistics;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import io.netty.util.Timeout;
  14 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  15 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  16
  17 /**
  18  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 27.2.2015.
  19  */
  20 public interface StatisticsContext extends RequestContextStack, AutoCloseable {
  21
  22     ListenableFuture<Boolean> gatherDynamicData();
  23
  24     /**
  25      * @param pollTimeout handle to nearest scheduled statistics poll
  26      */
  27     void setPollTimeout(Timeout pollTimeout);
  28
  29     /**
  30      * @return handle to currently scheduled statistics polling
  31      */
  32     Optional<Timeout> getPollTimeout();
  33
  34     /**
  35      * @return dedicated item life cycle change listener (per device)
  36      */
  37     ItemLifecycleListener getItemLifeCycleListener();
  38 }