opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/IPluginOutDataPacketService.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 /**
  11  * @file   IPluginOutDataPacketService.java
  12  *
  13  * @brief  Interface SAL will need to register in order to get some
  14  * packets from the southbound protocol plugins
  15  *
  16  * Interface SAL will need to register in order to get some
  17  * packets from the southbound protocol plugins
  18  */
  19
  20 package org.opendaylight.controller.sal.packet;
  21
  22 /**
  23  * Interface used by SAL to intercept any Data Packet coming from the
  24  * southbound protocol plugins
  25  */
  26 public interface IPluginOutDataPacketService {
  27     /**
  28      * Handler for receiving the packet. The SAL layer can signal back
  29      * to the southbound plugin if the packet has been consumed or can
  30      * go for further processing. Usually after SAL processing
  31      * probably there is no other processing to be done, but just in
  32      * case there is chain the return code can be used.
  33      * The protocol plugin is supposed to deliver a packet with the
  34      * IncomingNodeConnector set
  35      *
  36      * @param inPkt Packet received
  37      *
  38      * @return An indication if the packet should still be processed
  39      * or we should stop it.
  40      */
  41     PacketResult receiveDataPacket(RawPacket inPkt);
  42 }