ActiveIO - 1.0

Clover coverage report - ActiveIO - 1.0 Coverage timestamp: Fri Apr 22 2005 14:27:22 PDT FRAMES NO FRAMES |
file stats: | LOC: | 54 |  | Methods: | 0
| NCLOC: | 8 |  | Classes: | 1
30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover
Source file | Conditionals | Statements | Methods | TOTAL
Service.java | - | - | - | - |

1 |  |
     /**
2 |  |
      *
3 |  |
      * Copyright 2004 Hiram Chirino
4 |  |
      *
5 |  |
      *  Licensed under the Apache License, Version 2.0 (the "License");
6 |  |
      *  you may not use this file except in compliance with the License.
7 |  |
      *  You may obtain a copy of the License at
8 |  |
      *
9 |  |
      *     http://www.apache.org/licenses/LICENSE-2.0
10 |  |
      *
11 |  |
      *  Unless required by applicable law or agreed to in writing, software
12 |  |
      *  distributed under the License is distributed on an "AS IS" BASIS,
13 |  |
      *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 |  |
      *  See the License for the specific language governing permissions and
15 |  |
      *  limitations under the License.
16 |  |
      */
17 |  |
18 |  |
     package org.activeio;
19 |  |
20 |  |
     import java.io.IOException;
21 |  |
22 |  |
     /**
23 |  |
      * The Service interface is used control the running state of a channel.
24 |  |
      *
25 |  |
      * Some channels may use background threads to provide SEDA style processing.  By
26 |  |
      * implenting the Service interface, a protcol can allow a container to
27 |  |
      * control those threads.
28 |  |
      *
29 |  |
      * @version $Revision$
30 |  |
      */
31 |  |
     public interface Service {
32 |  |
33 |  |
         static final public long NO_WAIT_TIMEOUT=0;
34 |  |
         static final public long WAIT_FOREVER_TIMEOUT=-1;
35 |  |
36 |  |
         /**
37 |  |
          * Starts the channel.  Once started, the channel is in the running state.
38 |  |
          *
39 |  |
          * @throws IOException
40 |  |
          */
41 |  |
         void start() throws IOException;
42 |  |
43 |  |
         /**
44 |  |
          * Stops the channel.  Once stopped, the channel is in the stopped state.
45 |  |
          *
46 |  |
          * @param timeout The amount of time the channel is allowed to take to gracefully stop.  If the timeout
47 |  |
          *        is exceeded, the channel should do a forcefull stop.
48 |  |
          *
49 |  |
          * @throws IOException
50 |  |
          */
51 |  |
         void stop(long timeout) throws IOException;
52 |  |
53 |  |
     }
54 |  |