org.apache.sshd.common.channel.throttle.DefaultChannelStreamWriter Maven / Gradle / Ivy

Go to download

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

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.common.channel.throttle;

import java.io.IOException;

import org.apache.sshd.common.channel.Channel;
import org.apache.sshd.common.io.IoWriteFuture;
import org.apache.sshd.common.util.buffer.Buffer;

/**
 * A ChannelStreamWriter that simply calls the {@link Channel#writePacket(Buffer)} method.
 *
 * @author Apache MINA SSHD Project
 */
public class DefaultChannelStreamWriter implements ChannelStreamWriter {

    protected final Channel channel;
    protected volatile boolean closed;

    public DefaultChannelStreamWriter(Channel channel) {
        this.channel = channel;
    }

    @Override
    public IoWriteFuture writeData(Buffer buffer) throws IOException {
        if (closed) {
            throw new IOException("ChannelStreamPacketWriter has been closed");
        }
        return channel.writePacket(buffer);
    }

    @Override
    public boolean isOpen() {
        return !closed;
    }

    @Override
    public void close() throws IOException {
        closed = true;
    }
}