org.opendaylight.vtn.manager.internal.packet

Class PacketOutQueue

java.lang.Object

org.opendaylight.vtn.manager.internal.packet.PacketOutQueue

All Implemented Interfaces:

TxHook

public final class PacketOutQueue
extends Object
implements TxHook

PacketOutQueue describes a queue for packets to transmit.

An instance of this class must be obtained by TxContext.getSpecific(Class). All the queued packets are transmitted just after the successful completion of the MD-SAL datastore transaction associated with this instance. Note that packets will be discarded when the transaction is canceled.

Constructor Summary

Constructors

Constructor and Description
PacketOutQueue(TxContext ctx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	enqueue(SalPort egress, Packet packet) Enqueue the given packet to the transmission queue.
int	getOrder() Return an integer that determines the order of execution.
void	run(TxContext ctx, TxTask<?> task) Invoked when the MD-SAL datastore transaction has been submitted successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PacketOutQueue

public PacketOutQueue(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

enqueue

public void enqueue(SalPort egress,
                    Packet packet)

Enqueue the given packet to the transmission queue.

Parameters:

egress - A SalPort instance which specifies the egress switch port.

packet - A Packet instance to transmit.

run

public void run(TxContext ctx,
                TxTask<?> task)

Invoked when the MD-SAL datastore transaction has been submitted successfully.

This method transmits all the packets in the transmission queue.

Specified by:

run in interface TxHook

Parameters:

ctx - A runtime context for transaction task.

task - The current transaction task.

getOrder

public int getOrder()

Return an integer that determines the order of execution.

Registered hooks are executed in ascending order of order values.

Specified by:

getOrder in interface TxHook

Returns:

An integer that determines the order of execution.