org.apache.sshd.common.future.CloseFuture Maven / Gradle / Ivy

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

There is a newer version: 2.12.1

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

/**
 * An {@link SshFuture} for asynchronous close requests.
 *
 * @author Apache MINA SSHD Project
 */
public interface CloseFuture extends SshFuture {

    /**
     * @return true if the close request is finished and the target is closed.
     */
    boolean isClosed();

    /**
     * Marks this future as closed and notifies all threads waiting for this
     * future.  This method is invoked by SSHD internally.  Please do not call
     * this method directly.
     */
    void setClosed();

}