Subversion Repositories Programming Utils

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
86 rm5248 1
/*
2
 * Licensed to the Apache Software Foundation (ASF) under one
3
 * or more contributor license agreements.  See the NOTICE file
4
 * distributed with this work for additional information
5
 * regarding copyright ownership.  The ASF licenses this file
6
 * to you under the Apache License, Version 2.0 (the
7
 * "License"); you may not use this file except in compliance
8
 * with the License.  You may obtain a copy of the License at
9
 *
10
 *   http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing,
13
 * software distributed under the License is distributed on an
14
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15
 * KIND, either express or implied.  See the License for the
16
 * specific language governing permissions and limitations
17
 * under the License.
18
 */
19
package org.apache.sshd.common;
20
 
21
import java.io.IOException;
22
 
23
import org.apache.sshd.client.future.OpenFuture;
24
import org.apache.sshd.common.channel.Window;
25
import org.apache.sshd.common.future.CloseFuture;
26
import org.apache.sshd.common.session.ConnectionService;
27
import org.apache.sshd.common.util.Buffer;
28
 
29
/**
30
 * TODO Add javadoc
31
 *
32
 * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
33
 */
34
public interface Channel extends Closeable {
35
 
36
    int getId();
37
 
38
    int getRecipient();
39
 
40
    Window getLocalWindow();
41
 
42
    Window getRemoteWindow();
43
 
44
    Session getSession();
45
 
46
    void handleClose() throws IOException;
47
 
48
    void handleWindowAdjust(Buffer buffer) throws IOException;
49
 
50
    void handleRequest(Buffer buffer) throws IOException;
51
 
52
    void handleData(Buffer buffer) throws IOException;
53
 
54
    void handleExtendedData(Buffer buffer) throws IOException;
55
 
56
    void handleEof() throws IOException;
57
 
58
    void handleFailure() throws IOException;
59
 
60
    CloseFuture close(boolean immediately);
61
 
62
    void init(ConnectionService service, Session session, int id) throws IOException;
63
 
64
    /**
65
     * For a server channel, this method will actually open the channel
66
     */
67
    OpenFuture open(int recipient, int rwsize, int rmpsize, Buffer buffer);
68
 
69
    /**
70
     * For a client channel, this method will be called internally by the session when the confirmation
71
     * has been received.
72
     */
73
    void handleOpenSuccess(int recipient, int rwsize, int rmpsize, Buffer buffer) throws IOException;
74
 
75
    /**
76
     * For a client channel, this method will be called internally by the session when
77
     * the server has rejected this channel opening.
78
     */
79
    void handleOpenFailure(Buffer buffer) throws IOException;
80
 
81
}