org.apache.sshd.common.channel

Interface Channel

All Superinterfaces:

AutoCloseable, Channel, Closeable

public interface Channel
extends Closeable

TODO Add javadoc

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
int	getId()
Window	getLocalWindow()
int	getRecipient()
Window	getRemoteWindow()
Session	getSession()
void	handleClose()
void	handleData(Buffer buffer)
void	handleEof()
void	handleExtendedData(Buffer buffer)
void	handleFailure()
void	handleOpenFailure(Buffer buffer) For a client channel, this method will be called internally by the session when the server has rejected this channel opening.
void	handleOpenSuccess(int recipient, int rwSize, int packetSize, Buffer buffer) For a client channel, this method will be called internally by the session when the confirmation has been received.
void	handleRequest(Buffer buffer)
void	handleWindowAdjust(Buffer buffer)
void	init(ConnectionService service, Session session, int id)
OpenFuture	open(int recipient, int rwSize, int packetSize, Buffer buffer) For a server channel, this method will actually open the channel

Methods inherited from interface org.apache.sshd.common.Closeable

isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

getId

int getId()

Returns:

Local channel identifier

getRecipient

int getRecipient()

Returns:

Remote channel identifier

getLocalWindow

Window getLocalWindow()

getRemoteWindow

Window getRemoteWindow()

getSession

Session getSession()

handleClose

void handleClose()
          throws IOException

Throws:

IOException

handleWindowAdjust

void handleWindowAdjust(Buffer buffer)
                 throws IOException

Throws:

IOException

handleRequest

void handleRequest(Buffer buffer)
            throws IOException

Throws:

IOException

handleData

void handleData(Buffer buffer)
         throws IOException

Throws:

IOException

handleExtendedData

void handleExtendedData(Buffer buffer)
                 throws IOException

Throws:

IOException

handleEof

void handleEof()
        throws IOException

Throws:

IOException

handleFailure

void handleFailure()
            throws IOException

Throws:

IOException

close

CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

init

void init(ConnectionService service,
          Session session,
          int id)
   throws IOException

Throws:

IOException

open

OpenFuture open(int recipient,
                int rwSize,
                int packetSize,
                Buffer buffer)

For a server channel, this method will actually open the channel

Parameters:

recipient - Recipient identifier

rwSize - Read/Write window size

packetSize - Preferred maximum packet size

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Returns:

An OpenFuture for the channel open request

handleOpenSuccess

void handleOpenSuccess(int recipient,
                       int rwSize,
                       int packetSize,
                       Buffer buffer)
                throws IOException

For a client channel, this method will be called internally by the session when the confirmation has been received.

Parameters:

recipient - Recipient identifier

rwSize - Read/Write window size

packetSize - Preferred maximum packet size

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Throws:

IOException - If failed to handle the success

handleOpenFailure

void handleOpenFailure(Buffer buffer)
                throws IOException

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Parameters:

buffer - Incoming Buffer that triggered the call. Note: the buffer's read position is exactly after the information that read to this call was decoded

Throws:

IOException - If failed to handle the success