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
|
/***************************************************************************
* Copyright (c) 2004 - 2008 Eike Stepper, Germany.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
**************************************************************************/
package org.eclipse.net4j;
import java.nio.ByteBuffer;
import java.nio.channels.SocketChannel;
/**
* Enumerates the internal states of an {@link IBuffer}.
* <p>
* <dt><b>State Machine Diagram:</b></dt>
* <dd><img src="doc-files/BufferStates.png" title="Diagram Buffer States" border="0" usemap="#BufferStates.png"/></dd>
* <p>
* <MAP NAME="BufferStates.png"> <AREA SHAPE="RECT" COORDS="300,8,449,34" HREF="BufferState.html#INITIAL"> <AREA
* SHAPE="RECT" COORDS="46,115,195,139" HREF="BufferState.html#PUTTING"> <AREA SHAPE="RECT" COORDS="48,271,195,295"
* HREF="BufferState.html#WRITING"> <AREA SHAPE="RECT" COORDS="533,112,681,140" HREF="BufferState.html#READING_HEADER">
* <AREA SHAPE="RECT" COORDS="533,271,680,295" HREF="BufferState.html#READING_BODY"> <AREA SHAPE="RECT"
* COORDS="532,428,682,451" HREF="BufferState.html#GETTING"> </MAP>
*
* @author Eike Stepper
*/
public enum BufferState
{
/**
* Indicates that the {@link IBuffer} has just been provided by its {@link IBufferProvider}} or that is has been used
* and subsequently {@link IBuffer#clear() cleared}.
* <p>
* A transition to {@link #PUTTING} can be triggered by calling {@link IBuffer#startPutting(short)} once. If the
* buffer is intended to be passed to an {@link IChannel} later the {@link IChannel#getChannelIndex() channel index}
* of that Channel has to be passed because it is part of the buffer's header. A {@link ByteBuffer} is returned that
* can be used for putting data.
* <p>
* A transition to {@link #GETTING} can be triggered by calling {@link IBuffer#startGetting(SocketChannel)} repeatedly
* until it finally returns a {@link ByteBuffer} that can be used for getting data.
*/
INITIAL,
/**
* Indicates that the {@link IBuffer} can provide a {@link ByteBuffer} that can be used for putting data.
* <p>
* A transition to {@link #WRITING} can be triggered by calling {@link IBuffer#write(SocketChannel)}.
* <p>
* A transition to {@link #GETTING} can be triggered by calling {@link IBuffer#flip()}.
* <p>
* A transition to {@link #INITIAL} can be triggered by calling {@link IBuffer#clear()}.
* <p>
*/
PUTTING,
/**
* Indicates that the {@link IBuffer} is currently writing its data to a {@link SocketChannel}.
* <p>
* Self transitions to {@link #WRITING} can be triggered by repeatedly calling {@link IBuffer#write(SocketChannel)}
* until it returns <code>true</code>.
* <p>
* A transition to {@link #INITIAL} can be triggered by calling {@link IBuffer#clear()}.
* <p>
*/
WRITING,
/**
* Indicates that the {@link IBuffer} is currently reading its header from a {@link SocketChannel}.
* <p>
* Transitions to {@link #READING_HEADER}, {@link #READING_BODY} or {@link #GETTING} can be triggered by repeatedly
* calling {@link IBuffer#startGetting(SocketChannel)} until it returns a {@link ByteBuffer} that can be used for
* getting data.
* <p>
* A transition to {@link #INITIAL} can be triggered by calling {@link IBuffer#clear()}.
* <p>
*/
READING_HEADER,
/**
* Indicates that the {@link IBuffer} is currently reading its body from a {@link SocketChannel}.
* <p>
* Transitions to {@link #READING_BODY} or {@link #GETTING} can be triggered by repeatedly calling
* {@link IBuffer#startGetting(SocketChannel)} until it returns a {@link ByteBuffer} that can be used for getting
* data.
* <p>
* A transition to {@link #INITIAL} can be triggered by calling {@link IBuffer#clear()}.
* <p>
*/
READING_BODY,
/**
* Indicates that the {@link IBuffer} can provide a {@link ByteBuffer} that can be used for getting data.
* <p>
* A transition to {@link #INITIAL} can be triggered by calling {@link IBuffer#clear()}.
* <p>
*/
GETTING
}
|
