javax.microedition.io.UDPDatagramConnection Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package javax.microedition.io;
import java.io.IOException;
/**
* This interface defines a datagram connection which knows
* it's local end point address.
* The protocol is transaction oriented, and delivery and duplicate
* protection are not guaranteed. Applications requiring ordered
* reliable delivery of streams of data should use
* the SocketConnection.
*
* A UDPDatagramConnection is returned from
* Connector.open() in response to a request to
* open a datagram:// URL connection string.
* If the connection string omits both the host
* and port fields in the URL string, then the
* system will allocate an available port. The local
* address and the local port can be discovered using
* the accessor methods within this interface.
*
*
* The syntax described here for the datagram URL connection string
* is also valid for the Datagram.setAddress() method
* used to assign a destination address to a Datagram
* to be sent. e.g., datagram://host:port
*
*
* BNF Format for Connector.open() string
*
*
* The URI must conform to the BNF syntax specified below. If the URI
* does not conform to this syntax, an IllegalArgumentException
* is thrown.
*
*
*
* <datagram_connection_string>
* ::= "datagram://" |
* "datagram://"<hostport>
*
*
* <hostport>
* ::= host ":" port
*
*
* <host>
* ::= host name or IP address
* (omitted for inbound connections)
*
*
* <port>
* ::= numeric port number (omitted for system assigned port)
*
*
* @since MIDP 2.0
*/
public interface UDPDatagramConnection extends DatagramConnection
{
/**
* Gets the local address to which the
* datagram connection is bound.
*
* The host address(IP number) that can be used to connect to this
* end of the datagram connection from an external system.
* Since IP addresses may be dynamically assigned, a remote application
* will need to be robust in the face of IP number reassignment.
* The local hostname (if available) can be accessed from
* System.getProperty("microedition.hostname")
*
*
* @return the local address to which the datagram connection is bound.
* @exception IOException if the connection was closed.
* @see ServerSocketConnection
*/
public String getLocalAddress() throws IOException;
/**
* Returns the local port to which this datagram connection is bound.
*
* @return the local port number to which this datagram connection
* is connected.
* @exception IOException if the connection was closed.
* @see ServerSocketConnection
*/
public int getLocalPort() throws IOException;
}