##### Coverage Report - com.sun.grizzly.SelectionKeyHandler

Classes in this File | Line Coverage | Branch Coverage | Complexity
SelectionKeyHandler |
N/A | N/A
N/A | N/A
| 0.0;0

1 |  |
     /*
2 |  |
      *
3 |  |
      * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 |  |
      *
5 |  |
      * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
6 |  |
      *
7 |  |
      * The contents of this file are subject to the terms of either the GNU
8 |  |
      * General Public License Version 2 only ("GPL") or the Common Development
9 |  |
      * and Distribution License("CDDL") (collectively, the "License").  You
10 |  |
      * may not use this file except in compliance with the License. You can obtain
11 |  |
      * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12 |  |
      * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
13 |  |
      * language governing permissions and limitations under the License.
14 |  |
      *
15 |  |
      * When distributing the software, include this License Header Notice in each
16 |  |
      * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17 |  |
      * Sun designates this particular file as subject to the "Classpath" exception
18 |  |
      * as provided by Sun in the GPL Version 2 section of the License file that
19 |  |
      * accompanied this code.  If applicable, add the following below the License
20 |  |
      * Header, with the fields enclosed by brackets [] replaced by your own
21 |  |
      * identifying information: "Portions Copyrighted [year]
22 |  |
      * [name of copyright owner]"
23 |  |
      *
24 |  |
      * Contributor(s):
25 |  |
      *
26 |  |
      * If you wish your version of this file to be governed by only the CDDL or
27 |  |
      * only the GPL Version 2, indicate your decision by adding "[Contributor]
28 |  |
      * elects to include this software in this distribution under the [CDDL or GPL
29 |  |
      * Version 2] license."  If you don't indicate a single choice of license, a
30 |  |
      * recipient has the option to distribute your version of this file under
31 |  |
      * either the CDDL, the GPL Version 2 or to extend the choice of license to
32 |  |
      * its licensees as provided above.  However, if you add GPL Version 2 code
33 |  |
      * and therefore, elected the GPL Version 2 license, then the option applies
34 |  |
      * only if the new code is made subject to such option by the copyright
35 |  |
      * holder.
36 |  |
      *
37 |  |
      */
38 |  |
     package com.sun.grizzly;
39 |  |
40 |  |
     import com.sun.grizzly.util.Copyable;
41 |  |
     import java.nio.channels.ClosedChannelException;
42 |  |
     import java.nio.channels.SelectableChannel;
43 |  |
     import java.nio.channels.SelectionKey;
44 |  |
     import java.util.Iterator;
45 |  |
46 |  |
     /**
47 |  |
      * A SelectionKeyHandler is used to handle the life cycle of a SelectionKey.
48 |  |
      * Operations like cancelling, registering or closing are handled by
49 |  |
      * SelectionKeyHandler.
50 |  |
      *
51 |  |
      * @author Jeanfrancois Arcand
52 |  |
      */
53 |  |
     public interface SelectionKeyHandler extends Handler, Copyable {
54 |  |
55 |  |
         /**
56 |  |
          * Get associated {@link SelectorHandler}
57 |  |
          */
58 |  |
         public SelectorHandler getSelectorHandler();
59 |  |
60 |  |
61 |  |
         /**
62 |  |
          * Set associated {@link SelectorHandler}
63 |  |
          */
64 |  |
         public void setSelectorHandler(SelectorHandler selectorHandler);
65 |  |
66 |  |
67 |  |
         /**
68 |  |
          * {@link SelectionKey} process notification
69 |  |
          * @param key {@link SelectionKey} to process
70 |  |
          */
71 |  |
         public void process(SelectionKey key);
72 |  |
73 |  |
74 |  |
         /**
75 |  |
          * {@link SelectionKey} post process notification
76 |  |
          * @param key {@link SelectionKey} to process
77 |  |
          */
78 |  |
         public void postProcess(SelectionKey key);
79 |  |
80 |  |
81 |  |
         /**
82 |  |
          * Attach a times out to the SelectionKey used to cancel
83 |  |
          * idle connection. Null when the feature is not required.
84 |  |
          *
85 |  |
          * @param key {@link SelectionKey} to register
86 |  |
          * @param currentTime the System.currentTimeMillis
87 |  |
          *
88 |  |
          * @deprecated
89 |  |
          */
90 |  |
         public void register(SelectionKey key, long currentTime);
91 |  |
92 |  |
93 |  |
         /**
94 |  |
          * Register a {@link SelectionKey} on {@link Selector}.
95 |  |
          *
96 |  |
          * @param key {@link SelectionKey}
97 |  |
          * @param selectionKeyOps The interest set to apply when registering.
98 |  |
          * to register
99 |  |
          */
100 |  |
         public void register(SelectionKey key, int selectionKeyOps);
101 |  |
102 |  |
         /**
103 |  |
          * Register a {@link SelectableChannel} on {@link Selector}.
104 |  |
          *
105 |  |
          * @param channel {@link SelectableChannel}
106 |  |
          * @param selectionKeyOps The interest set to apply when registering.
107 |  |
          * to register
108 |  |
          */
109 |  |
         public void register(SelectableChannel channel,
110 |  |
                 int selectionKeyOps) throws ClosedChannelException;
111 |  |
112 |  |
113 |  |
         /**
114 |  |
          * Register a set of {@link SelectionKey}s.
115 |  |
          * Note: After processing each {@link SelectionKey} it should be
116 |  |
          * removed from <code>Iterator</code>
117 |  |
          *
118 |  |
          * @param selectionKeySet <code>Iterator</code> of {@link SelectionKey}s
119 |  |
          * @param selectionKeyOps The interest set to apply when registering.
120 |  |
          * to register
121 |  |
          */
122 |  |
         public void register(Iterator<SelectionKey> keyIterator, int selectionKeyOps);
123 |  |
124 |  |
125 |  |
         /**
126 |  |
          * Expire a {@link SelectionKey}. If a {@link SelectionKey} is
127 |  |
          * inactive for certain time (timeout),  the {@link SelectionKey}
128 |  |
          * will be cancelled and its associated Channel closed.
129 |  |
          * @param key {@link SelectionKey} to expire
130 |  |
          * @param currentTime the System.currentTimeMillis
131 |  |
          * @deprecated
132 |  |
          */
133 |  |
         public void expire(SelectionKey key, long currentTime);
134 |  |
135 |  |
136 |  |
         /**
137 |  |
          * Expire a {@link SelectionKey} set. Method checks
138 |  |
          * each {@link SelectionKey} from the{@link Set}. And if
139 |  |
          * a {@link SelectionKey} is inactive for certain time (timeout),
140 |  |
          * the {@link SelectionKey} will be cancelled and its associated Channel closed.
141 |  |
          * @param keyIterator <code>Iterator</code> of {@link SelectionKey}s
142 |  |
          * to expire
143 |  |
          */
144 |  |
         public void expire(Iterator<SelectionKey> keyIterator);
145 |  |
146 |  |
147 |  |
         /**
148 |  |
          * Cancel a SelectionKey and close its Channel.
149 |  |
          * @param key {@link SelectionKey} to cancel
150 |  |
          */
151 |  |
         public void cancel(SelectionKey key);
152 |  |
153 |  |
154 |  |
         /**
155 |  |
          * Close the SelectionKey's channel input or output, but keep alive
156 |  |
          * the SelectionKey.
157 |  |
          * @param key {@link SelectionKey} to close
158 |  |
          */
159 |  |
         public void close(SelectionKey key);
160 |  |
161 |  |
     }