org.apache.http.nio.entity.ConsumingNHttpEntity.java Source code

Introduction

Here is the source code for org.apache.http.nio.entity.ConsumingNHttpEntity.java

Source

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.http.nio.entity;

import java.io.IOException;

import org.apache.http.HttpEntity;
import org.apache.http.nio.ContentDecoder;
import org.apache.http.nio.IOControl;

/**
 * A non-blocking {@link HttpEntity} that allows content to be streamed from a
 * {@link ContentDecoder}.
 *
 * @since 4.0
 */
public interface ConsumingNHttpEntity extends HttpEntity {

    /**
     * Notification that content is available to be read from the decoder.
     * {@link IOControl} instance passed as a parameter to the method can be
     * used to suspend input events if the entity is temporarily unable to
     * allocate more storage to accommodate all incoming content.
     *
     * @param decoder content decoder.
     * @param ioctrl I/O control of the underlying connection.
     */
    void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws IOException;

    /**
     * Notification that any resources allocated for reading can be released.
     */
    void finish() throws IOException;

}