org.projectfloodlight.openflow.protocol

Interface OFMessageReader<T>

public interface OFMessageReader<T>

Method Summary

Modifier and Type	Method and Description
T	readFrom(io.netty.buffer.ByteBuf bb) Read the next available openflow message from the given byte buffer.

Method Detail

readFrom

@Nullable
T readFrom(@Nonnull
                     io.netty.buffer.ByteBuf bb)
              throws OFParseError

Read the next available openflow message from the given byte buffer. Returns null if not enough data is available on the byte buffer. Throws OFParseError if a protocol error occurs. Byte Buffer post-conditions:

• After a successful read, the byte buffer read position is positioned after the last-read message
• After the method has returned null (indicating an incomplete message), the buffer read position is unchanged from the previous attempt (i.e., they next read will attempt to re-read from the same position)
• After OFParseError is thrown, the read position of the byte buffer is undefined.

Parameters:

bb - input byte buffer

Returns:

the parsed of message or null if not enough data is available in the buffer

Throws:

OFParseError - if a protocol error occurs.