blob: ad5325ca8dede0f3316a3e16cd097c605689d1ed (
plain)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* ServiceChannel.java February 2014
*
* Copyright (C) 2014, Niall Gallagher <niallg@users.sf.net>
*
* 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.
*/
package org.simpleframework.http.socket.service;
import java.io.IOException;
import org.simpleframework.http.socket.Frame;
import org.simpleframework.http.socket.FrameListener;
import org.simpleframework.http.socket.Reason;
import org.simpleframework.http.socket.FrameChannel;
/**
* The <code>ServiceChannel</code> represents a full duplex communication
* channel as defined by RFC 6455. Any instance of this will provide
* a means to perform asynchronous writes and reads to a remote client
* using a lightweight framing protocol. A frame is a finite length
* sequence of bytes that can hold either text or binary data. Also,
* control frames are used to perform heartbeat monitoring and closure.
* <p>
* For convenience frames can be consumed from the socket via a
* callback to a registered listener. This avoids having to poll each
* socket for data and provides a asynchronous event driven model of
* communication, which greatly reduces overhead and complication.
*
* @author Niall Gallagher
*/
class ServiceChannel implements FrameChannel {
/**
* This is the internal channel for full duplex communication.
*/
private final FrameChannel channel;
/**
* Constructor for the <code>ServiceChannel</code> object. This is
* used to create a channel that is given to the application. This
* is synchronized so only one frame can be dispatched at a time.
*
* @param channel this is the channel to delegate to
*/
public ServiceChannel(FrameChannel channel) {
this.channel = channel;
}
/**
* This is used to send data to the connected client. To prevent
* an application code from causing resource issues this will block
* as soon as a configured linked list of mapped memory buffers has
* been exhausted. Caution should be taken when writing a broadcast
* implementation that can write to multiple sockets as a badly
* behaving socket that has filled its output buffering capacity
* can cause congestion.
*
* @param data this is the data that is to be sent
*/
public synchronized void send(byte[] data) throws IOException {
channel.send(data);
}
/**
* This is used to send text to the connected client. To prevent
* an application code from causing resource issues this will block
* as soon as a configured linked list of mapped memory buffers has
* been exhausted. Caution should be taken when writing a broadcast
* implementation that can write to multiple sockets as a badly
* behaving socket that has filled its output buffering capacity
* can cause congestion.
*
* @param text this is the text that is to be sent
*/
public synchronized void send(String text) throws IOException {
channel.send(text);
}
/**
* This is used to send data to the connected client. To prevent
* an application code from causing resource issues this will block
* as soon as a configured linked list of mapped memory buffers has
* been exhausted. Caution should be taken when writing a broadcast
* implementation that can write to multiple sockets as a badly
* behaving socket that has filled its output buffering capacity
* can cause congestion.
*
* @param frame this is the frame that is to be sent
*/
public synchronized void send(Frame frame) throws IOException {
channel.send(frame);
}
/**
* This is used to register a <code>FrameListener</code> to this
* instance. The registered listener will receive all user frames
* and control frames sent from the client. Also, when the frame
* is closed or when an unexpected error occurs the listener is
* notified. Any number of listeners can be registered at any time.
*
* @param listener this is the listener that is to be registered
*/
public synchronized void register(FrameListener listener) throws IOException {
channel.register(listener);
}
/**
* This is used to remove a <code>FrameListener</code> from this
* instance. After removal the listener will no longer receive
* any user frames or control messages from this specific instance.
*
* @param listener this is the listener to be removed
*/
public synchronized void remove(FrameListener listener) throws IOException {
channel.remove(listener);
}
/**
* This is used to close the connection with a specific reason.
* The close reason will be sent as a control frame before the
* TCP connection is terminated.
*
* @param reason the reason for closing the connection
*/
public synchronized void close(Reason reason) throws IOException {
channel.close(reason);
}
/**
* This is used to close the connection without a specific reason.
* The close reason will be sent as a control frame before the
* TCP connection is terminated.
*/
public void close() throws IOException {
channel.close();
}
}
|
