Android - An Open Handset Alliance Project

java.net
public abstract class

java.net.DatagramSocketImpl

java.lang.Object
	java.net.DatagramSocketImpl	SocketOptions

The abstract superclass of datagram & multicast socket implementations.

Summary

Constants inherited from interface java.net.SocketOptions

IP_MULTICAST_IF, IP_MULTICAST_IF2, IP_MULTICAST_LOOP, IP_TOS, SO_BINDADDR, SO_BROADCAST, SO_KEEPALIVE, SO_LINGER, SO_OOBINLINE, SO_RCVBUF, SO_REUSEADDR, SO_SNDBUF, SO_TIMEOUT, TCP_NODELAY

			Value
int	IP_MULTICAST_IF		16	0x00000010
int	IP_MULTICAST_IF2		31	0x0000001f
int	IP_MULTICAST_LOOP		18	0x00000012
int	IP_TOS		3	0x00000003
int	SO_BINDADDR		15	0x0000000f
int	SO_BROADCAST		32	0x00000020
int	SO_KEEPALIVE		8	0x00000008
int	SO_LINGER		128	0x00000080
int	SO_OOBINLINE		4099	0x00001003
int	SO_RCVBUF		4098	0x00001002
int	SO_REUSEADDR		4	0x00000004
int	SO_SNDBUF		4097	0x00001001
int	SO_TIMEOUT	Timeout for blocking operation.	4102	0x00001006
int	TCP_NODELAY		1	0x00000001

Fields

protected			FileDescriptor	fd
protected			int	localPort

Public Constructors

					DatagramSocketImpl()
					Constructs an unbound datagram socket implementation.

Public Methods

abstract	Object	getOption(int optID)
		Answer the nominated socket option.
abstract	void	setOption(int optID, Object val)
		Set the nominated socket option.

Protected Methods

abstract	void	bind(int port, InetAddress addr)
		Bind the datagram socket to the nominated localhost/port.
abstract	void	close()
		Close the socket.
	void	connect(InetAddress inetAddr, int port)
		Connect the socket to the specified remote address and port.
abstract	void	create()
		This method allocates the socket descriptor in the underlying operating system.
	void	disconnect()
		Disconnect the socket from the remote address and port.
	FileDescriptor	getFileDescriptor()
		Answer the FileDescriptor, which will be invalid if the socket is closed or not bound.
	int	getLocalPort()
		Answer the local port.
abstract	byte	getTTL()
		This method is deprecated. Replaced by getTimeToLive
abstract	int	getTimeToLive()
		Answer the time-to-live (TTL) for multicast packets sent on this socket.
abstract	void	join(InetAddress addr)
		Add this socket to the multicast group.
abstract	void	joinGroup(SocketAddress addr, NetworkInterface netInterface)
		Add this socket to the multicast group.
abstract	void	leave(InetAddress addr)
		Remove the socket from the multicast group.
abstract	void	leaveGroup(SocketAddress addr, NetworkInterface netInterface)
		Remove the socket from the multicast group.
abstract	int	peek(InetAddress sender)
		Peek at the incoming packet to this socket and answer the sender's address into `sender`.
abstract	int	peekData(DatagramPacket pack)
		Receive data into the supplied datagram packet by peeking.
abstract	void	receive(DatagramPacket pack)
		Receive data into the supplied datagram packet.
abstract	void	send(DatagramPacket pack)
		Sends the supplied datagram packet.
abstract	void	setTTL(byte ttl)
		This method is deprecated. Replaced by setTimeToLive
abstract	void	setTimeToLive(int ttl)
		Set the time-to-live (TTL) for multicast packets sent on this socket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.net.SocketOptions

getOption, setOption

Details

Fields

protected FileDescriptor fd

protected int localPort

Public Constructors

public DatagramSocketImpl()

Constructs an unbound datagram socket implementation.

Public Methods

public abstract Object getOption(int optID)

Answer the nominated socket option.

Parameters

optID	the socket option to retrieve

Returns

Object the option value

Throws

SocketException	thrown if an error occurs while accessing the option

public abstract void setOption(int optID, Object val)

Set the nominated socket option.

Parameters

optID	the socket option to set
val	the option value

Throws

SocketException	thrown if an error occurs while setting the option

Protected Methods

protected abstract void bind(int port, InetAddress addr)

Bind the datagram socket to the nominated localhost/port. Sockets must be bound prior to attempting to send or receive data.

Parameters

port	the port on the localhost to bind
addr	the address on the multihomed localhost to bind

Throws

SocketException	if an error occurred during bind, such as if the port was already bound

protected abstract void close()

Close the socket.

protected void connect(InetAddress inetAddr, int port)

Connect the socket to the specified remote address and port.

Parameters

inetAddr	the remote address
port	the remote port

Throws

SocketException	possibly thrown, if the datagram socket cannot be connected to the specified remote address and port

protected abstract void create()

This method allocates the socket descriptor in the underlying operating system.

Throws

SocketException

protected void disconnect()

Disconnect the socket from the remote address and port.

protected FileDescriptor getFileDescriptor()

Answer the FileDescriptor, which will be invalid if the socket is closed or not bound.

Returns

FileDescriptor the socket file descriptor

protected int getLocalPort()

Answer the local port. If the socket was bound to any available port, as flagged by a localPort value of -1, query the IP stack.

Returns

int the local port to which the socket is bound.

protected abstract byte getTTL()

This method is deprecated. Replaced by getTimeToLive

Answer the time-to-live (TTL) for multicast packets sent on this socket.

Returns

java.net.InetAddress

Throws

IOException	The exception description.

protected abstract int getTimeToLive()

Answer the time-to-live (TTL) for multicast packets sent on this socket.

Returns

Throws

IOException	The exception description.

protected abstract void join(InetAddress addr)

Add this socket to the multicast group. A socket must join a group before data may be received. A socket may be a member of multiple groups but may join any group once.

Parameters

addr	the multicast group to be joined

Throws

IOException	may be thrown while joining a group

protected abstract void joinGroup(SocketAddress addr, NetworkInterface netInterface)

Add this socket to the multicast group. A socket must join a group before data may be received. A socket may be a member of multiple groups but may join any group once.

Parameters

addr	the multicast group to be joined
netInterface	the network interface on which the addresses should be dropped

Throws

IOException	may be thrown while joining a group

protected abstract void leave(InetAddress addr)

Remove the socket from the multicast group.

Parameters

addr	the multicast group to be left

Throws

IOException	May be thrown while leaving the group

protected abstract void leaveGroup(SocketAddress addr, NetworkInterface netInterface)

Remove the socket from the multicast group.

Parameters

addr	the multicast group to be left
netInterface	the network interface on which the addresses should be dropped

Throws

IOException	May be thrown while leaving the group

protected abstract int peek(InetAddress sender)

Peek at the incoming packet to this socket and answer the sender's address into sender. The method will block until a packet is received or timeout expires and returns the sender's port.

Throws

IOException	if a read error or timeout occurs

protected abstract int peekData(DatagramPacket pack)

Receive data into the supplied datagram packet by peeking. The data is not removed and will be received by another peekData() or receive() call. This call will block until either data is received or, if a timeout is set, the timeout expires.

Parameters

pack	the DatagramPacket used to store the data

Returns

the port the packet was received from

Throws

IOException	if an error occurs

protected abstract void receive(DatagramPacket pack)

Receive data into the supplied datagram packet. This call will block until either data is received or, if a timeout is set, the timeout expires. If the timeout expires, the InterruptedIOException is thrown.

Throws

IOException	if a read error or timeout occurs

protected abstract void send(DatagramPacket pack)

Sends the supplied datagram packet. The packet contains the destination host & port.

Parameters

pack	DatagramPacket to send

Throws

IOException	if a write error occurs

protected abstract void setTTL(byte ttl)

This method is deprecated. Replaced by setTimeToLive

Set the time-to-live (TTL) for multicast packets sent on this socket.

Parameters

ttl	the time-to-live, 0 < ttl <= 255

Throws

IOException	The exception thrown while setting the TTL

protected abstract void setTimeToLive(int ttl)

Set the time-to-live (TTL) for multicast packets sent on this socket.

Parameters

ttl	the time-to-live, 0 < ttl <= 255

Throws

IOException	The exception thrown while setting the TTL

				Object	getOption(int optID)
					Answer the declared socket option.
				void	setOption(int optID, Object val)
					Set the declared socket option to the value.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.net.DatagramSocketImpl

Summary

Constants inherited from interface java.net.SocketOptions

Fields

Public Constructors

Public Methods

Protected Methods

Methods inherited from class java.lang.Object

Methods inherited from interface java.net.SocketOptions

Details

Fields

protected FileDescriptor fd

protected int localPort

Public Constructors

public DatagramSocketImpl()

Public Methods

public abstract Object getOption(int optID)

Parameters

Returns

Throws

public abstract void setOption(int optID, Object val)

Parameters

Throws

Protected Methods

protected abstract void bind(int port, InetAddress addr)

Parameters

Throws

protected abstract void close()

protected void connect(InetAddress inetAddr, int port)

Parameters

Throws

protected abstract void create()

Throws

protected void disconnect()

protected FileDescriptor getFileDescriptor()

Returns

protected int getLocalPort()

Returns

protected abstract byte getTTL()

Returns

Throws

See Also

protected abstract int getTimeToLive()

Returns

Throws

protected abstract void join(InetAddress addr)

Parameters

Throws

protected abstract void joinGroup(SocketAddress addr, NetworkInterface netInterface)

Parameters

Throws

protected abstract void leave(InetAddress addr)

Parameters

Throws

protected abstract void leaveGroup(SocketAddress addr, NetworkInterface netInterface)

Parameters

Throws

protected abstract int peek(InetAddress sender)

Throws

protected abstract int peekData(DatagramPacket pack)

Parameters

Returns

Throws

protected abstract void receive(DatagramPacket pack)

Throws

protected abstract void send(DatagramPacket pack)

Parameters

Throws

protected abstract void setTTL(byte ttl)

Parameters

Throws

See Also

protected abstract void setTimeToLive(int ttl)

Parameters

Throws