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