com.hp.of.ctl.pkt

Interface PacketOut

All Known Implementing Classes:

PacketOutAdapter

public interface PacketOut

Presents SequencedPacketListeners with the operations they can perform on the Packet-Out currently under construction in the MessageContext.

This approach provides an abstraction for packet listeners, allowing us to present a narrowed API to the mutable Packet-Out message.

Author:

Simon Hunt, Thomas Vachuska

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(Action action) Adds an action to the list of actions for this packet-out message.
void	block() Blocks any downstream directors from emitting a packet-out response.
void	clearActions() Clears any actions accrued so far, but leaves open the possibility to add others.
void	send() Instructs the sequencer to send the packet-out response.

Method Detail

addAction

void addAction(Action action)

Adds an action to the list of actions for this packet-out message.

Parameters:

action - the action to add

Throws:

IllegalStateException - if caller is not a Director, or if the packet has already been handled

clearActions

void clearActions()

Clears any actions accrued so far, but leaves open the possibility to add others.

Throws:

IllegalStateException - if caller is not a Director, or if the packet has already been handled

block

void block()

Blocks any downstream directors from emitting a packet-out response. This is irreversible.

Throws:

IllegalStateException - if caller is not a Director, or if the packet has already been handled

send

void send()

Instructs the sequencer to send the packet-out response. This is irreversible.

Throws:

IllegalStateException - if caller is not a Director, or if the packet has already been handled