org.waarp.ftp.core.data.handler

Class FtpDataModeCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.ByteToMessageCodec<org.waarp.common.file.DataBlock>

org.waarp.ftp.core.data.handler.FtpDataModeCodec

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public class FtpDataModeCodec
extends io.netty.handler.codec.ByteToMessageCodec<org.waarp.common.file.DataBlock>

First CODEC :
- encode : takes a DataBlock and transforms it to a ByteBuf
- decode : takes a ByteBuf and transforms it to a DataBlock
STREAM and BLOCK mode are implemented. COMPRESSED mode is not implemented.

Author:

Frederic Bregier

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
FtpDataModeCodec(FtpArgumentCode.TransferMode mode, FtpArgumentCode.TransferStructure structure)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buf, List<Object> out)
protected org.waarp.common.file.DataBlock	decodeRecord(io.netty.buffer.ByteBuf buf, int length)
protected org.waarp.common.file.DataBlock	decodeRecordStandard(io.netty.buffer.ByteBuf buf, int length)
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, org.waarp.common.file.DataBlock msg, io.netty.buffer.ByteBuf out)
protected io.netty.buffer.ByteBuf	encode(org.waarp.common.file.DataBlock msg) Encode a DataBlock in the correct format for Mode
protected io.netty.buffer.ByteBuf	encodeRecord(org.waarp.common.file.DataBlock msg, io.netty.buffer.ByteBuf buffer)
protected io.netty.buffer.ByteBuf	encodeRecordStandard(org.waarp.common.file.DataBlock msg, io.netty.buffer.ByteBuf buffer)
FtpArgumentCode.TransferMode	getMode()
FtpArgumentCode.TransferStructure	getStructure()
void	setCodecReady() Inform the Codec that DataNetworkHandler is ready (called from DataNetworkHandler after setCorrectCodec).
void	setMode(FtpArgumentCode.TransferMode mode)
void	setStructure(FtpArgumentCode.TransferStructure structure)

Methods inherited from class io.netty.handler.codec.ByteToMessageCodec

acceptOutboundMessage, channelInactive, channelRead, channelReadComplete, decodeLast, handlerAdded, handlerRemoved, write

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, 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

exceptionCaught

Constructor Detail

FtpDataModeCodec

public FtpDataModeCodec(FtpArgumentCode.TransferMode mode,
                FtpArgumentCode.TransferStructure structure)

Parameters:

mode -

structure -

Method Detail

setCodecReady

public void setCodecReady()

Inform the Codec that DataNetworkHandler is ready (called from DataNetworkHandler after setCorrectCodec).

decodeRecordStandard

protected org.waarp.common.file.DataBlock decodeRecordStandard(io.netty.buffer.ByteBuf buf,
                                                   int length)

decodeRecord

protected org.waarp.common.file.DataBlock decodeRecord(io.netty.buffer.ByteBuf buf,
                                           int length)

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf buf,
          List<Object> out)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageCodec<org.waarp.common.file.DataBlock>

Throws:

Exception

encodeRecordStandard

protected io.netty.buffer.ByteBuf encodeRecordStandard(org.waarp.common.file.DataBlock msg,
                                           io.netty.buffer.ByteBuf buffer)

encodeRecord

protected io.netty.buffer.ByteBuf encodeRecord(org.waarp.common.file.DataBlock msg,
                                   io.netty.buffer.ByteBuf buffer)

encode

protected io.netty.buffer.ByteBuf encode(org.waarp.common.file.DataBlock msg)
                                  throws org.waarp.common.exception.InvalidArgumentException

Encode a DataBlock in the correct format for Mode

Parameters:

msg -

Returns:

the ByteBuf or null when the last block is already done

Throws:

org.waarp.common.exception.InvalidArgumentException

getMode

public FtpArgumentCode.TransferMode getMode()

Returns:

the mode

setMode

public void setMode(FtpArgumentCode.TransferMode mode)

Parameters:

mode - the mode to set

getStructure

public FtpArgumentCode.TransferStructure getStructure()

Returns:

the structure

setStructure

public void setStructure(FtpArgumentCode.TransferStructure structure)

Parameters:

structure - the structure to set

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
          org.waarp.common.file.DataBlock msg,
          io.netty.buffer.ByteBuf out)
               throws Exception

Specified by:

encode in class io.netty.handler.codec.ByteToMessageCodec<org.waarp.common.file.DataBlock>

Throws:

Exception