blob: e7f2c4f78cbcb537afa887eb042f92a27b8f7435 (
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
|
/*
* FlushSignaller.java February 2008
*
* Copyright (C) 2008, 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.transport;
import static org.simpleframework.transport.TransportEvent.ERROR;
import java.nio.channels.SocketChannel;
import org.simpleframework.transport.reactor.Operation;
import org.simpleframework.transport.trace.Trace;
/**
* The <code>FlushSignaller</code> is an operation that performs
* writes operation asynchronously. This will basically determine
* if the socket is write ready and drain each queued buffer to
* the socket until there are no more pending buffers.
*
* @author Niall Gallagher
*/
class FlushSignaller implements Operation {
/**
* This is the writer that is used to write the data.
*/
private final SocketFlusher writer;
/**
* This is the socket that this will be flushing.
*/
private final Socket socket;
/**
* This is used to trace the activity for the operation.
*/
private final Trace trace;
/**
* Constructor for the <code>FlushSignaller</code> object. This
* will create an operation that is used to flush the buffer
* queue to the underlying socket. This ensures that the data
* is written to the socket in the queued order.
*
* @param writer this is the writer to flush the data to
* @param socket this is the socket to be flushed
*/
public FlushSignaller(SocketFlusher writer, Socket socket) {
this.trace = socket.getTrace();
this.socket = socket;
this.writer = writer;
}
/**
* This is used to acquire the trace object that is associated
* with the operation. A trace object is used to collection details
* on what operations are being performed. For instance it may
* contain information relating to I/O events or errors.
*
* @return this returns the trace associated with this operation
*/
public Trace getTrace() {
return trace;
}
/**
* This returns the socket channel for the connected pipeline. It
* is this channel that is used to determine if there are bytes
* that can be written. When closed this is no longer selectable.
*
* @return this returns the connected channel for the pipeline
*/
public SocketChannel getChannel() {
return socket.getChannel();
}
/**
* This is used to perform the drain of the pending buffer
* queue. This will drain each pending queue if the socket is
* write ready. If the socket is not write ready the operation
* is enqueued for selection and this returns. This ensures
* that all the data will eventually be delivered.
*/
public void run() {
try {
writer.execute();
} catch(Exception cause) {
trace.trace(ERROR, cause);
cancel();
}
}
/**
* This is used to cancel the operation if it has timed out.
* If the delegate is waiting too long to flush the contents
* of the buffers to the underlying transport then the socket
* is closed and the flusher times out to avoid deadlock.
*/
public void cancel() {
try {
writer.abort();
}catch(Exception cause){
trace.trace(ERROR, cause);
}
}
}
|
