1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.nio.entity;
29
30 import java.io.IOException;
31
32 import org.apache.http.HttpEntity;
33 import org.apache.http.nio.ContentEncoder;
34 import org.apache.http.nio.IOControl;
35
36 /**
37 * An {@link HttpEntity} that can stream content out into a
38 * {@link ContentEncoder}.
39 *
40 * @since 4.0
41 *
42 * @deprecated use (4.2)
43 * {@link org.apache.http.nio.protocol.BasicAsyncRequestProducer}
44 * or {@link org.apache.http.nio.protocol.BasicAsyncResponseProducer}
45 */
46 @Deprecated
47 public interface ProducingNHttpEntity extends HttpEntity {
48
49 /**
50 * Notification that content should be written to the encoder.
51 * {@link IOControl} instance passed as a parameter to the method can be
52 * used to suspend output events if the entity is temporarily unable to
53 * produce more content.
54 * <p>
55 * When all content is finished, this <b>MUST</b> call {@link ContentEncoder#complete()}.
56 * Failure to do so could result in the entity never being written.
57 *
58 * @param encoder content encoder.
59 * @param ioControl I/O control of the underlying connection.
60 */
61 void produceContent(ContentEncoder encoder, IOControl ioControl) throws IOException;
62
63 /**
64 * Notification that any resources allocated for writing can be released.
65 */
66 void finish() throws IOException;
67
68 }