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.DeviceContext;
  15 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  16 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
  17
  18 /**
  19  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 27.2.2015.
  20  */
  21 public interface StatisticsContext extends RequestContextStack, AutoCloseable {
  22
  23     ListenableFuture<Boolean> gatherDynamicData();
  24
  25     /**
  26      * Method has to be called from DeviceInitialization Method, otherwise
  27      * we are not able to poll anything. Statistics Context normally initialize
  28      * this part by initialization process but we don't have this information
  29      * in initialization phase and we have to populate whole list after every
  30      * device future collecting. Because device future collecting set DeviceState
  31      * and we creating marks for the correct kind of stats from DeviceState.
  32      */
  33     void statListForCollectingInitialization();
  34
  35     /**
  36      * @param pollTimeout handle to nearest scheduled statistics poll
  37      */
  38     void setPollTimeout(Timeout pollTimeout);
  39
  40     /**
  41      * @return handle to currently scheduled statistics polling
  42      */
  43     Optional<Timeout> getPollTimeout();
  44
  45     /**
  46      * @return dedicated item life cycle change listener (per device)
  47      */
  48     ItemLifecycleListener getItemLifeCycleListener();
  49
  50     /**
  51      * Statistics Context has to be able to return own DeviceCtx
  52      * @return {@link DeviceContext}
  53      */
  54     DeviceContext getDeviceContext();
  55
  56     @Override
  57     void close();
  58 }