forked from actframework/actframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathWebSocketConnection.java
More file actions
64 lines (55 loc) · 1.64 KB
/
WebSocketConnection.java
File metadata and controls
64 lines (55 loc) · 1.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package act.xio;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* Licensed 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.
* #L%
*/
import act.Destroyable;
import act.conf.AppConfig;
/**
* A WebSocket connection
*/
public interface WebSocketConnection extends Destroyable {
/**
* Session ID of this connection
* @return connection session id
*/
String sessionId();
/**
* Returns the username which is gained when connection is setup
* by calling {@link org.osgl.http.H.Session#get(String)} with
* {@link AppConfig#sessionKeyUsername()}
*
* @return the username or `null` if there is no logged in user when connection is setup
*/
String username();
/**
* Send a text message through websocket
* @param message the text message
*/
void send(String message);
/**
* Close the connection. Note if there are any `IOException`
* raised by the underline network layer, it will be ignored
*/
void close();
/**
* Check if the connection has been closed
* @return `true` if connection is closed
*/
boolean closed();
}