View Javadoc

1   /*
2    *  Copyright 2006 Simon Raess
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.beep4j.internal;
17  
18  import net.sf.beep4j.CloseChannelRequest;
19  import net.sf.beep4j.ProfileInfo;
20  
21  /**
22   * The SessionManager is used to start / close channels.
23   * 
24   * @author Simon Raess
25   */
26  public interface SessionManager {
27  	
28  	/**
29  	 * Requests to start a new channel or cancels the request.
30  	 * 
31  	 * @param channelNumber the channel number
32  	 * @param profiles the list of acceptable profiles
33  	 * @return the response from the application
34  	 */
35  	StartChannelResponse channelStartRequested(int channelNumber, ProfileInfo[] profiles);
36  	
37  	/**
38  	 * Requests to close the channel identified by the given channel number.
39  	 * The request can either be accepted (resulting in a close channel) or
40  	 * declined (in which case the channel stays open).
41  	 * 
42  	 * @param channelNumber the channel number
43  	 * @param request the close request
44  	 */
45  	void channelCloseRequested(int channelNumber, CloseChannelRequest request);
46  	
47  	/**
48  	 * Closes the session.
49  	 * 
50  	 * @param callback the callback that gets notified about the outcome
51  	 */
52  	void sessionCloseRequested(CloseCallback callback);
53  	
54  }