org.apache.sshd.common.io.IoInputStream Maven / Gradle / Ivy
/*
* 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.
*/
package org.apache.sshd.common.io;
import org.apache.sshd.common.Closeable;
import org.apache.sshd.common.util.buffer.Buffer;
/**
* Represents a stream that can be read asynchronously.
*
* @author Apache MINA SSHD Project
*/
public interface IoInputStream extends Closeable {
/**
* NOTE: the buffer must not be touched until the returned read future is completed.
*
* @param buffer the {@link Buffer} to use
* @return The {@link IoReadFuture} for the operation
*/
IoReadFuture read(Buffer buffer);
}