opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/packet/IPluginInDataPacketService.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   IPluginInDataPacketService.java
  12  *
  13  * @brief  Data Packet Services exported by SouthBound plugins for SAL usage
  14  *
  15  * Data Packet Services exported by SouthBound plugins for SAL usage
  16  */
  17 package org.opendaylight.controller.sal.packet;
  18
  19 /**
  20  * Data Packet Services exported by SouthBound plugins for SAL usage.
  21  * The service will be used by SAL such that for every Protocol Plugin
  22  * there is only one expected, for this reason the service need to be
  23  * registered in the OSGi service registry along with the property:
  24  * - "protocoloPluginType"
  25  * the value of the property will org.opendaylight.controller.sal.core.Node.NodeIDType
  26  */
  27 public interface IPluginInDataPacketService {
  28     /**
  29      * Transmit a data Packet. Packet will go out ONLY if the packet
  30      * has property OutgoingNodeConnector set.
  31      *
  32      * @param outPkt Packet to be transmitted out
  33      */
  34     void transmitDataPacket(RawPacket outPkt);
  35 }