001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.nio.entity;
029
030import java.io.IOException;
031
032import org.apache.http.HttpEntity;
033import org.apache.http.nio.ContentEncoder;
034import org.apache.http.nio.IOControl;
035
036/**
037 * An {@link HttpEntity} that can stream content out into a
038 * {@link ContentEncoder}.
039 *
040 * @since 4.0
041 *
042 * @deprecated use (4.2)
043 *  {@link org.apache.http.nio.protocol.BasicAsyncRequestProducer}
044 *  or {@link org.apache.http.nio.protocol.BasicAsyncResponseProducer}
045 */
046@Deprecated
047public interface ProducingNHttpEntity extends HttpEntity {
048
049    /**
050     * Notification that content should be written to the encoder.
051     * {@link IOControl} instance passed as a parameter to the method can be
052     * used to suspend output events if the entity is temporarily unable to
053     * produce more content.
054     * <p>
055     * When all content is finished, this <b>MUST</b> call {@link ContentEncoder#complete()}.
056     * Failure to do so could result in the entity never being written.
057     *
058     * @param encoder content encoder.
059     * @param ioctrl I/O control of the underlying connection.
060     */
061    void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException;
062
063    /**
064     * Notification that any resources allocated for writing can be released.
065     */
066    void finish() throws IOException;
067
068}