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

io.netty.channel.oio.AbstractOioMessageChannel Maven / Gradle / Ivy

Go to download

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1
Show newest version
/*
 * Copyright 2012 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 io.netty.channel.oio;

import io.netty.channel.Channel;
import io.netty.channel.ChannelConfig;
import io.netty.channel.ChannelPipeline;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

/**
 * Abstract base class for OIO which reads and writes objects from/to a Socket
 */
public abstract class AbstractOioMessageChannel extends AbstractOioChannel {

    private final List readBuf = new ArrayList();

    protected AbstractOioMessageChannel(Channel parent) {
        super(parent);
    }

    @Override
    protected void doRead() {
        final ChannelConfig config = config();
        final ChannelPipeline pipeline = pipeline();
        boolean closed = false;
        final int maxMessagesPerRead = config.getMaxMessagesPerRead();

        Throwable exception = null;
        int localRead = 0;
        int totalRead = 0;
        try {
            for (;;) {
                // Perform a read.
                localRead = doReadMessages(readBuf);
                if (localRead == 0) {
                    break;
                }
                if (localRead < 0) {
                    closed = true;
                    break;
                }

                // Notify with the received messages and clear the buffer.
                int size = readBuf.size();
                for (int i = 0; i < size; i ++) {
                    pipeline.fireChannelRead(readBuf.get(i));
                }
                readBuf.clear();

                // Do not read beyond maxMessagesPerRead.
                // Do not continue reading if autoRead has been turned off.
                totalRead += localRead;
                if (totalRead >= maxMessagesPerRead || !config.isAutoRead()) {
                    break;
                }
            }
        } catch (Throwable t) {
            exception = t;
        }

        pipeline.fireChannelReadComplete();

        if (exception != null) {
            if (exception instanceof IOException) {
                closed = true;
            }

            pipeline().fireExceptionCaught(exception);
        }

        if (closed) {
            if (isOpen()) {
                unsafe().close(unsafe().voidPromise());
            }
        } else if (localRead == 0 && isActive()) {
            // If the read amount was 0 and the channel is still active we need to trigger a new read()
            // as otherwise we will never try to read again and the user will never know.
            // Just call read() is ok here as it will be submitted to the EventLoop as a task and so we are
            // able to process the rest of the tasks in the queue first.
            //
            // See https://github.com/netty/netty/issues/2404
            read();
        }
    }

    /**
     * Read messages into the given array and return the amount which was read.
     */
    protected abstract int doReadMessages(List msgs) throws Exception;
}