##### Coverage Report - com.sun.grizzly.connectioncache.spi.transport.ConnectionCache

Classes in this File | Line Coverage | Branch Coverage | Complexity
ConnectionCache |
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 |  |
39 |  |
     package com.sun.grizzly.connectioncache.spi.transport;
40 |  |
41 |  |
     import java.io.Closeable;
42 |  |
43 |  |
     /** A connection cache manages a group of connections which may be re-used
44 |  |
      * for sending and receiving messages.
45 |  |
      * @param C  a connection
46 |  |
      */
47 |  |
     public interface ConnectionCache<C extends Closeable> {
48 |  |
         /** User-provided indentifier for an instance of the
49 |  |
          * {@link ConnectionCache}.
50 |  |
          * @return  a <code>String</code> identifying an instance of a {@link ConnectionCache}
51 |  |
          */
52 |  |
         String getCacheType() ;
53 |  |
54 |  |
         /** Total number of connections currently managed by the cache.
55 |  |
          * @return  number of connections currently managed by the cache
56 |  |
          */
57 |  |
         long numberOfConnections() ;
58 |  |
59 |  |
         /** Number of idle connections; that is, connections for which the number of
60 |  |
          * get/release or responseReceived/responseProcessed calls are equal.
61 |  |
          * @return  number of idle connections
62 |  |
          */
63 |  |
         long numberOfIdleConnections() ;
64 |  |
65 |  |
         /** Number of non-idle connections.  Normally, busy+idle==total, but this
66 |  |
          * may not be strictly true due to concurrent updates to the connection
67 |  |
          * cache.
68 |  |
          * @return  number of busy connections
69 |  |
          */
70 |  |
         long numberOfBusyConnections() ;
71 |  |
72 |  |
         /** Number of idle connections that are reclaimable.  Such connections
73 |  |
          * are not in use, and are not waiting to handle any responses.
74 |  |
          * @return  number of idle connections that are reclaimable
75 |  |
          */
76 |  |
         long numberOfReclaimableConnections() ;
77 |  |
78 |  |
         /** Threshold at which connection reclamation begins.
79 |  |
          * @return  threshold at which connection reclamation begins.
80 |  |
          */
81 |  |
         int highWaterMark() ;
82 |  |
83 |  |
         /** Number of connections to reclaim each time reclamation starts.
84 |  |
          * @return  number of connections to reclaim
85 |  |
          */
86 |  |
         int numberToReclaim() ;
87 |  |
88 |  |
         /** Close a connection, regardless of its state.  This may cause requests
89 |  |
          * to fail to be sent, and responses to be lost.  Intended for
90 |  |
          * handling serious errors, such as loss of framing on a TCP stream,
91 |  |
          * that require closing the connection.
92 |  |
          * @param conn  a connection
93 |  |
          */
94 |  |
         void close( final C conn ) ;
95 |  |
     }