01: /*
02: *
03: *
04: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License version
09: * 2 only, as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful, but
12: * WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * General Public License version 2 for more details (a copy is
15: * included at /legal/license.txt).
16: *
17: * You should have received a copy of the GNU General Public License
18: * version 2 along with this work; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA
21: *
22: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
23: * Clara, CA 95054 or visit www.sun.com if you need additional
24: * information or have any questions.
25: */
26: package com.sun.kvem.jsr082.obex;
27:
28: import javax.microedition.io.Connection;
29: import java.io.IOException;
30:
31: public interface ObexTransport extends Connection {
32:
33: /**
34: * Reads the packet data into specified buffer.
35: * <p>
36: * If the specified buffer length is 0, then 0 data
37: * will be read into this buffer, and the rest of packet
38: * data is lost.
39: * <p>
40: *
41: *
42: * @param inData the data array to fill with received bytes.
43: *
44: * @exception IOException if a local or remote connection
45: * is closed or I/O error has happen.
46: *
47: * @exception NullPointerException if the specified buffer is null.
48: */
49: public int read(byte[] inData) throws IOException;
50:
51: /**
52: *
53: *
54: * @param outData the buffer with the data to be sent.
55: *
56: * @param len the number of bytes to be sent.
57: *
58: * @exception IOException if a local or remote connection
59: * is closed or I/O error has happen.
60: *
61: * @exception NullPointerException if the specified buffer is null.
62: */
63: public void write(byte[] outData, int len) throws IOException;
64:
65: /**
66: * Determines the amount of data (maximum packet size) that can
67: * be successfully sent in a single write operation. If the size
68: * of data is greater than the maximum packet size, then then only
69: * the first maximum packet size bytes of the packet are sent,
70: * and the rest will be discarded.
71: * <p>
72: * If the returned values is 0, this means the transport
73: * implementation is based on a stream protocol, i.e.
74: * any packet size may be used.
75: *
76: * @return the maximum number of bytes that can be sent/received
77: * in a single call to read()/ write() without losing any data.
78: */
79: public int getMaximumPacketSize();
80:
81: /**
82: * Get underlying connection.
83: */
84: public Connection getUnderlyingConnection();
85: } // end of interface 'ObexTransport' definition
|