ObexTransport.java revision 2e0da96e757a977154063f980d3f4e1abd41cf09 
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
33package javax.obex;
34
35import java.io.DataInputStream;
36import java.io.DataOutputStream;
37import java.io.IOException;
38import java.io.InputStream;
39import 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 * @hide
56 */
57public interface ObexTransport {
58
59    void create() throws IOException;
60
61    void listen() throws IOException;
62
63    void close() throws IOException;
64
65    void connect() throws IOException;
66
67    void disconnect() throws IOException;
68
69    InputStream openInputStream() throws IOException;
70
71    OutputStream openOutputStream() throws IOException;
72
73    DataInputStream openDataInputStream() throws IOException;
74
75    DataOutputStream openDataOutputStream() throws IOException;
76
77}
78