01: /*
02: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
04: *
05: * This program is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU General Public License version
07: * 2 only, as published by the Free Software Foundation.
08: *
09: * This program is distributed in the hope that it will be useful, but
10: * WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * General Public License version 2 for more details (a copy is
13: * included at /legal/license.txt).
14: *
15: * You should have received a copy of the GNU General Public License
16: * version 2 along with this work; if not, write to the Free Software
17: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18: * 02110-1301 USA
19: *
20: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
21: * Clara, CA 95054 or visit www.sun.com if you need additional
22: * information or have any questions.
23: */
24:
25: package com.sun.midp.push.gcf;
26:
27: /**
28: * Connection reservation.
29: *
30: * <p>
31: * Connection reservation is a push enabled protocol connection which is
32: * reserved for some application and is managed by the protocol. For details
33: * of protocol obligations in respect to reserved connections, see doc
34: * for {@link ReservationDescriptor#reserve}.
35: * </p>
36: */
37: public interface ConnectionReservation {
38: /**
39: * Checks if the reservation has available data.
40: *
41: * @return <code>true</code> iff there are available data
42: *
43: * @throws IllegalStateException if invoked after reservation cancellation
44: */
45: boolean hasAvailableData() throws IllegalStateException;
46:
47: /**
48: * Cancels reservation.
49: *
50: * <p>
51: * Cancelling should be guaranteed at least in
52: * the following sense: cancelled reservation's callback won't be invoked.
53: * </p>
54: *
55: * <p>
56: * However as callbacks can be invoked from another thread,
57: * the following scenario is possible and should be accounted for:
58: * <ol>
59: * <li>callback is scheduled for execution, but hasn't started yet</li>
60: * <li><code>cancel</code> method is invoked</li>
61: * <li>callback starts execution</li>
62: * </ol>
63: * </p>
64: *
65: * @throws IllegalStateException if invoked after reservation cancellation
66: */
67: void cancel() throws IllegalStateException;
68: }
|