com.sshtools.ssh.ChannelEventListener Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of j2ssh-maverick Show documentation
Open source SSH2 API
The newest version!
/**
 * Copyright 2003-2016 SSHTOOLS Limited. All Rights Reserved.
 *
 * For product documentation visit https://www.sshtools.com/
 *
 * This file is part of J2SSH Maverick.
 *
 * J2SSH Maverick is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * J2SSH Maverick is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with J2SSH Maverick.  If not, see .
 */
package com.sshtools.ssh;

/**
 * An event interface that provides notifications of SshChannel events.
 * 
 * @author Lee David Painter
 */
public interface ChannelEventListener {

	/**
	 * A channel has been opened. This is called once the client has confirmed,
	 * or received a confirmation from the server that a channel has been
	 * opened.
	 * 
	 * @param channel
	 *            the opened channel.
	 */
	public void channelOpened(SshChannel channel);

	/**
	 * A channel is closing. This is called before a channel is confirmed as
	 * being closed.
	 * 
	 * @param channel
	 *            the channel closing.
	 */
	public void channelClosing(SshChannel channel);

	/**
	 * A channel is closed. This is called when the channel has finally been
	 * closed.
	 * 
	 * @param channel
	 *            the closed channel.
	 */
	public void channelClosed(SshChannel channel);

	/**
	 * A channel's input is EOF. This is called when the remote side reports
	 * that it will not be sending any more data.
	 * 
	 * @param channel
	 *            SshChannel
	 */
	public void channelEOF(SshChannel channel);

	/**
	 * A block of data has been received by the channel. This implementation
	 * should provide the data but not interfere with normal data processing of
	 * the channel.
	 * 
	 * @param channel
	 *            SshChannel
	 * @param data
	 *            byte[]
	 * @param off
	 *            int
	 * @param len
	 *            int
	 */
	public void dataReceived(SshChannel channel, byte[] data, int off, int len);

	/**
	 * A block of data has been sent by the channel. This implementation should
	 * provide the data but not interfere with normal data processing of the
	 * channel.
	 * 
	 * @param channel
	 *            SshChannel
	 * @param data
	 *            byte[]
	 * @param off
	 *            int
	 * @param len
	 *            int
	 */
	public void dataSent(SshChannel channel, byte[] data, int off, int len);

	/**
	 * A block of extended data has been received by the channel.
	 * 
	 * @param channel
	 * @param data
	 * @param off
	 * @param len
	 * @param extendedDataType
	 *            the extended data type
	 */
	public void extendedDataReceived(SshChannel channel, byte[] data, int off,
			int len, int extendedDataType);

}