bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/BGPSessionListener.java

   1 /*
   2  * Copyright (c) 2013 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 package org.opendaylight.protocol.bgp.rib.spi;
   9
  10 import com.google.common.util.concurrent.ListenableFuture;
  11 import java.util.EventListener;
  12 import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  14 import org.opendaylight.yangtools.yang.binding.Notification;
  15
  16 /**
  17  * Listener that receives session informations from the session.
  18  */
  19 public interface BGPSessionListener extends EventListener {
  20
  21     /**
  22      * Marks synchronization finished for given Table key
  23      *
  24      * @param tablesKey of the table where synchronization finished
  25      */
  26     void markUptodate(final TablesKey tablesKey);
  27
  28     /**
  29      * Fired when the session was established successfully.
  30      *
  31      * @param session Peer address families which we accepted
  32      */
  33     void onSessionUp(BGPSession session);
  34     /**
  35      * Fired when the session went down because of an IO error. Implementation should take care of closing underlying
  36      * session.
  37      *
  38      * @param session that went down
  39      * @param e Exception that was thrown as the cause of session being down
  40      */
  41
  42     void onSessionDown(BGPSession session, Exception e);
  43     /**
  44      * Fired when the session is terminated locally. The session has already been closed and transitioned to IDLE state.
  45      * Any outstanding queued messages were not sent. The user should not attempt to make any use of the session.
  46      *
  47      * @param reason the cause why the session went down
  48      */
  49     void onSessionTerminated(BGPSession session, BGPTerminationReason reason);
  50
  51     /**
  52      * Fired when a normal protocol message is received.
  53      *
  54      * @param notification Protocol message
  55      */
  56     void onMessage(BGPSession session, Notification notification) throws BGPDocumentedException;
  57
  58     ListenableFuture<?> releaseConnection();
  59 }