Nick Pelly | 9439a7f | 2009-06-30 12:04:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2008-2009, Motorola, Inc. |
| 3 | * |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are met: |
| 8 | * |
| 9 | * - Redistributions of source code must retain the above copyright notice, |
| 10 | * this list of conditions and the following disclaimer. |
| 11 | * |
| 12 | * - Redistributions in binary form must reproduce the above copyright notice, |
| 13 | * this list of conditions and the following disclaimer in the documentation |
| 14 | * and/or other materials provided with the distribution. |
| 15 | * |
| 16 | * - Neither the name of the Motorola, Inc. nor the names of its contributors |
| 17 | * may be used to endorse or promote products derived from this software |
| 18 | * without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 21 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 22 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 23 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 24 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 25 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 26 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 29 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 30 | * POSSIBILITY OF SUCH DAMAGE. |
| 31 | */ |
| 32 | |
| 33 | package javax.obex; |
| 34 | |
| 35 | import java.io.DataInputStream; |
| 36 | import java.io.DataOutputStream; |
| 37 | import java.io.IOException; |
| 38 | import java.io.InputStream; |
| 39 | import java.io.OutputStream; |
| 40 | |
| 41 | /** |
| 42 | * The <code>ObexTransport</code> interface defines the underlying transport |
| 43 | * connection which carries the OBEX protocol( such as TCP, RFCOMM device file |
| 44 | * exposed by Bluetooth or USB in kernel, RFCOMM socket emulated in Android |
| 45 | * platform, Irda). This interface provides an abstract layer to be used by the |
| 46 | * <code>ObexConnection</code>. Each kind of medium shall have its own |
| 47 | * implementation to wrap and follow the same interface. |
| 48 | * <P> |
| 49 | * See section 1.2.2 of IrDA Object Exchange Protocol specification. |
| 50 | * <P> |
| 51 | * Different kind of medium may have different construction - for example, the |
| 52 | * RFCOMM device file medium may be constructed from a file descriptor or simply |
| 53 | * a string while the TCP medium usually from a socket. |
Nick Pelly | 2e0da96 | 2009-06-30 16:28:54 -0700 | [diff] [blame] | 54 | * @hide |
Nick Pelly | 9439a7f | 2009-06-30 12:04:36 -0700 | [diff] [blame] | 55 | */ |
| 56 | public interface ObexTransport { |
| 57 | |
| 58 | void create() throws IOException; |
| 59 | |
| 60 | void listen() throws IOException; |
| 61 | |
| 62 | void close() throws IOException; |
| 63 | |
| 64 | void connect() throws IOException; |
| 65 | |
| 66 | void disconnect() throws IOException; |
| 67 | |
| 68 | InputStream openInputStream() throws IOException; |
| 69 | |
| 70 | OutputStream openOutputStream() throws IOException; |
| 71 | |
| 72 | DataInputStream openDataInputStream() throws IOException; |
| 73 | |
| 74 | DataOutputStream openDataOutputStream() throws IOException; |
Nick Pelly | 9439a7f | 2009-06-30 12:04:36 -0700 | [diff] [blame] | 75 | |
Casper Bonde | 238e0f9 | 2015-04-09 09:24:48 +0200 | [diff] [blame] | 76 | /** |
| 77 | * Must return the maximum allowed OBEX packet that can be sent over |
| 78 | * the transport. For L2CAP this will be the Max SDU reported by the |
| 79 | * peer device. |
| 80 | * The returned value will be used to set the outgoing OBEX packet |
| 81 | * size. Therefore this value shall not change. |
| 82 | * For RFCOMM or other transport types where the OBEX packets size |
| 83 | * is unrelated to the transport packet size, return -1; |
| 84 | * @return the maximum allowed OBEX packet that can be send over |
| 85 | * the transport. Or -1 in case of don't care. |
| 86 | */ |
| 87 | int getMaxTransmitPacketSize(); |
| 88 | |
| 89 | /** |
| 90 | * Must return the maximum allowed OBEX packet that can be received over |
| 91 | * the transport. For L2CAP this will be the Max SDU configured for the |
| 92 | * L2CAP channel. |
| 93 | * The returned value will be used to validate the incoming packet size |
| 94 | * values. |
| 95 | * For RFCOMM or other transport types where the OBEX packets size |
| 96 | * is unrelated to the transport packet size, return -1; |
| 97 | * @return the maximum allowed OBEX packet that can be send over |
| 98 | * the transport. Or -1 in case of don't care. |
| 99 | */ |
| 100 | int getMaxReceivePacketSize(); |
| 101 | |
| 102 | /** |
| 103 | * Shall return true if the transport in use supports SRM. |
| 104 | * @return |
| 105 | * <code>true</code> if SRM operation is supported, and is to be enabled. |
| 106 | * <code>false</code> if SRM operations are not supported, or should not be used. |
| 107 | */ |
| 108 | boolean isSrmSupported(); |
| 109 | |
| 110 | |
Nick Pelly | 9439a7f | 2009-06-30 12:04:36 -0700 | [diff] [blame] | 111 | } |