All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ch.cern.hbase.thirdparty.io.netty.handler.codec.DatagramPacketEncoder Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2016 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package ch.cern.hbase.thirdparty.io.netty.handler.codec;

import ch.cern.hbase.thirdparty.io.netty.buffer.ByteBuf;
import ch.cern.hbase.thirdparty.io.netty.channel.AddressedEnvelope;
import ch.cern.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;
import ch.cern.hbase.thirdparty.io.netty.channel.ChannelPipeline;
import ch.cern.hbase.thirdparty.io.netty.channel.ChannelPromise;
import ch.cern.hbase.thirdparty.io.netty.channel.socket.DatagramPacket;
import ch.cern.hbase.thirdparty.io.netty.handler.codec.protobuf.ProtobufEncoder;
import ch.cern.hbase.thirdparty.io.netty.util.internal.StringUtil;
import static ch.cern.hbase.thirdparty.io.netty.util.internal.ObjectUtil.checkNotNull;

import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.List;

/**
 * An encoder that encodes the content in {@link AddressedEnvelope} to {@link DatagramPacket} using
 * the specified message encoder. E.g.,
 *
 * 

 * {@link ChannelPipeline} pipeline = ...;
 * pipeline.addLast("udpEncoder", new {@link DatagramPacketEncoder}(new {@link ProtobufEncoder}(...));
 * 
* * Note: As UDP packets are out-of-order, you should make sure the encoded message size are not greater than * the max safe packet size in your particular network path which guarantees no packet fragmentation. * * @param the type of message to be encoded */ public class DatagramPacketEncoder extends MessageToMessageEncoder> { private final MessageToMessageEncoder encoder; /** * Create an encoder that encodes the content in {@link AddressedEnvelope} to {@link DatagramPacket} using * the specified message encoder. * * @param encoder the specified message encoder */ public DatagramPacketEncoder(MessageToMessageEncoder encoder) { this.encoder = checkNotNull(encoder, "encoder"); } @Override public boolean acceptOutboundMessage(Object msg) throws Exception { if (super.acceptOutboundMessage(msg)) { @SuppressWarnings("rawtypes") AddressedEnvelope envelope = (AddressedEnvelope) msg; return encoder.acceptOutboundMessage(envelope.content()) && envelope.sender() instanceof InetSocketAddress && envelope.recipient() instanceof InetSocketAddress; } return false; } @Override protected void encode( ChannelHandlerContext ctx, AddressedEnvelope msg, List out) throws Exception { assert out.isEmpty(); encoder.encode(ctx, msg.content(), out); if (out.size() != 1) { throw new EncoderException( StringUtil.simpleClassName(encoder) + " must produce only one message."); } Object content = out.get(0); if (content instanceof ByteBuf) { // Replace the ByteBuf with a DatagramPacket. out.set(0, new DatagramPacket((ByteBuf) content, msg.recipient(), msg.sender())); } else { throw new EncoderException( StringUtil.simpleClassName(encoder) + " must produce only ByteBuf."); } } @Override public void bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) throws Exception { encoder.bind(ctx, localAddress, promise); } @Override public void connect( ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) throws Exception { encoder.connect(ctx, remoteAddress, localAddress, promise); } @Override public void disconnect(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception { encoder.disconnect(ctx, promise); } @Override public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception { encoder.close(ctx, promise); } @Override public void deregister(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception { encoder.deregister(ctx, promise); } @Override public void read(ChannelHandlerContext ctx) throws Exception { encoder.read(ctx); } @Override public void flush(ChannelHandlerContext ctx) throws Exception { encoder.flush(ctx); } @Override public void handlerAdded(ChannelHandlerContext ctx) throws Exception { encoder.handlerAdded(ctx); } @Override public void handlerRemoved(ChannelHandlerContext ctx) throws Exception { encoder.handlerRemoved(ctx); } @Override public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception { encoder.exceptionCaught(ctx, cause); } @Override public boolean isSharable() { return encoder.isSharable(); } }