OFFrameDecoder (openflowplugin 0.12.5-SNAPSHOT API)

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder
    - - org.opendaylight.openflowjava.protocol.impl.core.OFFrameDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
```
public class OFFrameDecoder
extends io.netty.handler.codec.ByteToMessageDecoder
```
Decodes incoming messages into message frames.

Author:

michal.polkorab

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
  io.netty.handler.codec.ByteToMessageDecoder.Cumulator
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields
Modifier and Type Field Description

static byte LENGTH_OF_HEADER
Length of OpenFlow header.
- Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
  COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors
Constructor Description

OFFrameDecoder(ConnectionFacade connectionFacade, boolean tlsPresent)
Constructor of class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`decode(io.netty.channel.ChannelHandlerContext chc, io.netty.buffer.ByteBuf bb, List<Object> list)`
`void`	`exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)`

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded

- Field Detail
  - LENGTH_OF_HEADER
```
public static final byte LENGTH_OF_HEADER
```
    Length of OpenFlow header.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OFFrameDecoder
```
public OFFrameDecoder(ConnectionFacade connectionFacade,
                      boolean tlsPresent)
```
    Constructor of class.
    
    Parameters:
    
    connectionFacade - ConnectionFacade that will be notified with ConnectionReadyNotification after TLS has been successfully set up.
    
    tlsPresent - true is TLS is required, false otherwise
- Method Detail
  - exceptionCaught
```
public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
```
    Specified by:
    
    exceptionCaught in interface io.netty.channel.ChannelHandler
    
    Specified by:
    
    exceptionCaught in interface io.netty.channel.ChannelInboundHandler
    
    Overrides:
    
    exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter
  - decode
```
protected void decode(io.netty.channel.ChannelHandlerContext chc,
                      io.netty.buffer.ByteBuf bb,
                      List<Object> list)
```
    Specified by:
    
    decode in class io.netty.handler.codec.ByteToMessageDecoder