bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/stats/peer/BGPSessionStats.java

   1 /*
   2  * Copyright (c) 2014 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.protocol.bgp.rib.impl.stats.peer;
  10
  11 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
  12
  13 /**
  14  * Serves to expose BGP session statistics to the BGP Peer, to which the session is related.
  15  */
  16 public interface BGPSessionStats {
  17
  18     /**
  19      * Retrieves actual BGP session state. Containing all information collected from the session.
  20      *
  21      * @return State of the BGP session.
  22      */
  23     BgpSessionState getBgpSessionState();
  24
  25     /**
  26      * Resets BGP session statistics. Sets counters values to zero.
  27      */
  28     void resetBgpSessionStats();
  29 }