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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show 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 org.apache.sshd.common.future.SshFuture;
import org.apache.sshd.common.future.VerifiableFuture;
import org.apache.sshd.common.util.buffer.Buffer;

/**
 * @author Apache MINA SSHD Project
 */
public interface IoReadFuture extends SshFuture, VerifiableFuture {

    /**
     * Retrieves the buffer data was read into.
     *
     * @return the buffer, {@code null} if {@link #isDone()} {@code == false}
     */
    Buffer getBuffer();

    /**
     * Retrieves the number of bytes read.
     *
     * @return The number of bytes read, or -1 if the source of the read has been exhausted (is at EOF), or zero if the
     *         read is not done yet ({@link #isDone()} {@code == false})
     */
    int getRead();

    /**
     * Returns the cause of the read failure. An {@link java.io.EOFException} indicates that nothing was read because
     * the source of the read is exhausted.
     *
     * @return {@code null} if the read operation is not finished yet, or if the read attempt is successful (use
     *         {@link #isDone()} to distinguish between the two).
     */
    Throwable getException();
}