org.apache.sshd.common.io.IoOutputStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation

The newest version!

/*
 * 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 java.io.IOException;

import org.apache.sshd.common.Closeable;
import org.apache.sshd.common.util.buffer.Buffer;

/**
 * Represents a stream that can be written asynchronously.
 *
 * @author Apache MINA SSHD Project
 */
public interface IoOutputStream extends Closeable {

    /**
     * Write the given buffer.
     *
     * @param  buffer      the data to write. NOTE: the buffer must not be touched until the returned write
     *                     future is completed.
     * @return             An {@code IoWriteFuture} that can be used to check when the data has actually been written.
     * @throws IOException if an error occurred when writing the data
     */
    IoWriteFuture writeBuffer(Buffer buffer) throws IOException;

}