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 com.android.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. 54 */ 55 public interface ObexTransport { 56 create()57 void create() throws IOException; 58 listen()59 void listen() throws IOException; 60 close()61 void close() throws IOException; 62 connect()63 void connect() throws IOException; 64 disconnect()65 void disconnect() throws IOException; 66 openInputStream()67 InputStream openInputStream() throws IOException; 68 openOutputStream()69 OutputStream openOutputStream() throws IOException; 70 openDataInputStream()71 DataInputStream openDataInputStream() throws IOException; 72 openDataOutputStream()73 DataOutputStream openDataOutputStream() throws IOException; 74 75 /** 76 * Must return the maximum allowed OBEX packet that can be sent over 77 * the transport. For L2CAP this will be the Max SDU reported by the 78 * peer device. 79 * The returned value will be used to set the outgoing OBEX packet 80 * size. Therefore this value shall not change. 81 * For RFCOMM or other transport types where the OBEX packets size 82 * is unrelated to the transport packet size, return -1; 83 * Exception can be made (like PBAP transport) with a smaller value 84 * to avoid bad effect on other profiles using the RFCOMM; 85 * @return the maximum allowed OBEX packet that can be send over 86 * the transport. Or -1 in case of don't care. 87 */ getMaxTransmitPacketSize()88 int getMaxTransmitPacketSize(); 89 90 /** 91 * Must return the maximum allowed OBEX packet that can be received over 92 * the transport. For L2CAP this will be the Max SDU configured for the 93 * L2CAP channel. 94 * The returned value will be used to validate the incoming packet size 95 * values. 96 * For RFCOMM or other transport types where the OBEX packets size 97 * is unrelated to the transport packet size, return -1; 98 * @return the maximum allowed OBEX packet that can be send over 99 * the transport. Or -1 in case of don't care. 100 */ getMaxReceivePacketSize()101 int getMaxReceivePacketSize(); 102 103 /** 104 * Shall return true if the transport in use supports SRM. 105 * @return 106 * <code>true</code> if SRM operation is supported, and is to be enabled. 107 * <code>false</code> if SRM operations are not supported, or should not be used. 108 */ isSrmSupported()109 boolean isSrmSupported(); 110 111 112 } 113