bgp/rib-spi/src/main/java/org/opendaylight/protocol/bgp/rib/spi/Peer.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
  12 /**
  13  * Marker interface identifying a BGP peer.
  14  */
  15 public interface Peer {
  16     /**
  17      * Return peer's symbolic name.
  18      *
  19      * @return symbolic name.
  20      */
  21     String getName();
  22
  23     /**
  24      * Return the peer's BGP identifier as raw bytearray
  25      * @return byte[] raw identifier
  26      */
  27     byte[] getRawIdentifier();
  28
  29     /**
  30      *  Close Peers and performs asynchronously DS clean up
  31      *
  32      * @return future
  33      */
  34     ListenableFuture<?> close();
  35 }