01: /*
02: * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0-beta1/module-nio/src/main/java/org/apache/http/nio/FileContentDecoder.java $
03: * $Revision: 594061 $
04: * $Date: 2007-11-12 10:34:55 +0100 (Mon, 12 Nov 2007) $
05: *
06: * ====================================================================
07: * Licensed to the Apache Software Foundation (ASF) under one
08: * or more contributor license agreements. See the NOTICE file
09: * distributed with this work for additional information
10: * regarding copyright ownership. The ASF licenses this file
11: * to you under the Apache License, Version 2.0 (the
12: * "License"); you may not use this file except in compliance
13: * with the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing,
18: * software distributed under the License is distributed on an
19: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20: * KIND, either express or implied. See the License for the
21: * specific language governing permissions and limitations
22: * under the License.
23: * ====================================================================
24: *
25: * This software consists of voluntary contributions made by many
26: * individuals on behalf of the Apache Software Foundation. For more
27: * information on the Apache Software Foundation, please see
28: * <http://www.apache.org/>.
29: *
30: */
31:
32: package org.apache.http.nio;
33:
34: import java.io.IOException;
35: import java.nio.channels.FileChannel;
36:
37: /**
38: * A content decoder capable of transferring data directly to a {@link FileChannel}
39: */
40: public interface FileContentDecoder extends ContentDecoder {
41:
42: /**
43: * Transfers a portion of entity content from the underlying network channel
44: * into the given file channel.
45: *
46: * @param dst the target FileChannel to transfer data into.
47: * @param position
48: * The position within the file at which the transfer is to begin;
49: * must be non-negative
50: * @param count
51: * The maximum number of bytes to be transferred; must be
52: * non-negative
53: * @throws IOException, if some I/O error occurs.
54: * @return The number of bytes, possibly zero,
55: * that were actually transferred
56: */
57: long transfer(FileChannel dst, long position, long count)
58: throws IOException;
59:
60: }
|