org.apache.sshd.sftp.client.SftpErrorDataHandler Maven / Gradle / Ivy

Go to download

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

There is a newer version: 2.14.0

/*
 * 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.sftp.client;

import java.io.IOException;

/**
 * Callback for any error stream data sent by the server
 *
 * @author Apache MINA SSHD Project
 */
@FunctionalInterface
public interface SftpErrorDataHandler {
    SftpErrorDataHandler EMPTY = (buf, start, len) -> {
        /* ignored */ };

    /**
     * Receive binary data from server error stream
     *
     * @param  buf         The buffer of the incoming data
     * @param  start       Offset in buffer to read the data
     * @param  len         Available data in buffer
     * @throws IOException If failed to receive incoming data
     */
    void errorData(byte[] buf, int start, int len) throws IOException;
}