01: /*
02: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: *
23: * Free Software Foundation, Inc.
24: * 59 Temple Place, Suite 330
25: * Boston, MA 02111-1307 USA
26: *
27: * @author Scott Ferguson
28: */
29:
30: package com.caucho.servlet.comet;
31:
32: /**
33: * Public API to control a comet connection.
34: */
35: public interface CometController {
36: /**
37: * Sets the max idle time.
38: */
39: public void setMaxIdleTime(long idleTime);
40:
41: /**
42: * Gets the max idle time.
43: */
44: public long getMaxIdleTime();
45:
46: /**
47: * Gets a request attribute.
48: */
49: public Object getAttribute(String name);
50:
51: /**
52: * Sets a request attribute.
53: */
54: public void setAttribute(String name, Object value);
55:
56: /**
57: * Remove a request attribute.
58: */
59: public void removeAttribute(String name);
60:
61: /**
62: * Wakes the connection.
63: */
64: public boolean wake();
65:
66: /**
67: * Returns true if the connection is closed.
68: */
69: public boolean isClosed();
70:
71: /**
72: * Closes the connection.
73: */
74: public void close();
75: }
|