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