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.hc.core5.http.nio; 29 30 import java.io.IOException; 31 import java.nio.Buffer; 32 33 import org.apache.hc.core5.annotation.Contract; 34 import org.apache.hc.core5.annotation.ThreadingBehavior; 35 36 /** 37 * Abstract data stream channel. 38 * <p> 39 * Implementations are expected to be thread-safe. 40 * </p> 41 * 42 * @param <T> data container accepted by the channel. 43 * 44 * @since 5.0 45 */ 46 @Contract(threading = ThreadingBehavior.SAFE) 47 public interface StreamChannel<T extends Buffer> { 48 49 /** 50 * Writes data from the data container into the underlying data stream. 51 * 52 * @param src source of data 53 * @return The number of elements written, possibly zero 54 */ 55 int write(T src) throws IOException; 56 57 /** 58 * Terminates the underlying data stream and optionally writes 59 * a closing sequence. 60 */ 61 void endStream() throws IOException; 62 }