Android - An Open Handset Alliance Project

java.net
public class

java.net.MulticastSocket

java.lang.Object
	java.net.DatagramSocket
		java.net.MulticastSocket

This class models a multicast socket for sending & receiving datagram packets to a multicast group.

Summary

Public Constructors

					MulticastSocket()
					Constructs a multicast socket, bound to any available port on the localhost.
					MulticastSocket(int aPort)
					Answers a multicast socket, bound to the nominated port on the localhost.
					MulticastSocket(SocketAddress localAddr)
					Constructs a MulticastSocket bound to the host/port specified by the SocketAddress, or an unbound DatagramSocket if the SocketAddress is null.

Public Methods

				InetAddress	getInterface()
					Answer the network address used by the socket.
				boolean	getLoopbackMode()
					Get the state of the IP_MULTICAST_LOOP socket option.
				NetworkInterface	getNetworkInterface()
					Answer the network interface used by the socket.
				byte	getTTL()
					This method is deprecated. Replaced by getTimeToLive
				int	getTimeToLive()
					Answer the time-to-live (TTL) for multicast packets sent on this socket.
				void	joinGroup(InetAddress groupAddr)
					Add this socket to the multicast group.
				void	joinGroup(SocketAddress groupAddress, NetworkInterface netInterface)
					Add this socket to the multicast group.
				void	leaveGroup(InetAddress groupAddr)
					Remove the socket from the multicast group.
				void	leaveGroup(SocketAddress groupAddress, NetworkInterface netInterface)
					Remove the socket from the multicast group.
				void	send(DatagramPacket pack, byte ttl)
					This method is deprecated. use MulticastSocket#setTimeToLive
				void	setInterface(InetAddress addr)
					Set the network address used by the socket.
				void	setLoopbackMode(boolean loop)
					Set the IP_MULTICAST_LOOP socket option.
				void	setNetworkInterface(NetworkInterface netInterface)
					Set the network interface used by the socket.
				void	setTTL(byte ttl)
					This method is deprecated. Replaced by setTimeToLive
				void	setTimeToLive(int ttl)
					Set the time-to-live (TTL) for multicast packets sent on this socket.

Methods inherited from class java.net.DatagramSocket

		void	bind(SocketAddress localAddr)
			Bind the DatagramSocket to the nominated local host/port.
		void	close()
			Close the socket.
		void	connect(InetAddress anAddress, int aPort)
			Connect the datagram socket to a remote host and port.
		void	connect(SocketAddress remoteAddr)
			Connect the datagram socket to a remote host and port.
		void	disconnect()
			'Disconnect' the datagram socket from a remote host and port.
		boolean	getBroadcast()
			Get the state of the SO_BROADCAST socket option.
		DatagramChannel	getChannel()
			if DatagramSocket is created by a DatagramChannel, returns the related DatagramChannel
		InetAddress	getInetAddress()
			Returns an InetAddress instance representing the address this socket has connected to.
		InetAddress	getLocalAddress()
			Returns an InetAddress instance representing the local address this socket is bound to.
		int	getLocalPort()
			Answer the local port to which the socket is bound.
		SocketAddress	getLocalSocketAddress()
			Answer the local SocketAddress for this socket, or null if the socket is not bound.
		int	getPort()
			Returns the number of the remote port this socket is connected to.
synchronized		int	getReceiveBufferSize()
			Answer the socket receive buffer size (SO_RCVBUF).
		SocketAddress	getRemoteSocketAddress()
			Answer the remote SocketAddress for this socket, or null if the socket is not connected.
		boolean	getReuseAddress()
			Get the state of the SO_REUSEADDR socket option.
synchronized		int	getSendBufferSize()
			Answer the socket send buffer size (SO_SNDBUF).
synchronized		int	getSoTimeout()
			Answer the socket receive timeout (SO_RCVTIMEOUT), in milliseconds.
		int	getTrafficClass()
			Get the IP_TOS socket option.
		boolean	isBound()
			Return if the socket is bound to a local address and port.
		boolean	isClosed()
			Return if the socket is closed.
		boolean	isConnected()
			Return if the socket is connected.
synchronized		void	receive(DatagramPacket pack)
			Receive on this socket into the packet argument.
		void	send(DatagramPacket pack)
			Send the packet on this socket.
		void	setBroadcast(boolean broadcast)
			Set the SO_BROADCAST socket option.
synchronized	static	void	setDatagramSocketImplFactory(DatagramSocketImplFactory fac)
			Specifies the application's socket implementation factory.
synchronized		void	setReceiveBufferSize(int size)
			Set the socket receive buffer size.
		void	setReuseAddress(boolean reuse)
			Set the SO_REUSEADDR socket option.
synchronized		void	setSendBufferSize(int size)
			Set the socket send buffer size.
synchronized		void	setSoTimeout(int timeout)
			Set the SO_RCVTIMEOUT to `timeout`, in milliseconds.
		void	setTrafficClass(int value)
			Set the IP_TOS socket option.

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`).

Details

Public Constructors

public MulticastSocket()

Constructs a multicast socket, bound to any available port on the localhost.

Throws

IOException	if a problem occurs creating or binding the socket

public MulticastSocket(int aPort)

Answers a multicast socket, bound to the nominated port on the localhost.

Parameters

aPort	the port to bind on the localhost

Throws

IOException	if a problem occurs creating or binding the socket

public MulticastSocket(SocketAddress localAddr)

Constructs a MulticastSocket bound to the host/port specified by the SocketAddress, or an unbound DatagramSocket if the SocketAddress is null.

Parameters

localAddr	the local machine address and port to bind to

Throws

IllegalArgumentException	if the SocketAddress is not supported
IOException	if a problem occurs creating or binding the socket

Public Methods

public InetAddress getInterface()

Answer the network address used by the socket. This is useful on multi-homed machines.

Returns

java.net.InetAddress the network address

Throws

SocketException	The exception thrown while getting the address

public boolean getLoopbackMode()

Get the state of the IP_MULTICAST_LOOP socket option.

Returns

true if the IP_MULTICAST_LOOP is enabled, false otherwise.

Throws

SocketException	if the socket is closed or the option is invalid.

public NetworkInterface getNetworkInterface()

Answer the network interface used by the socket. This is useful on multi-homed machines.

Returns

java.net.NetworkInterface the network address

Throws

SocketException	The exception thrown while getting the address

public 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.

public int getTimeToLive()

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

Returns

java.net.InetAddress

Throws

IOException	The exception description.

public void joinGroup(InetAddress groupAddr)

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

Parameters

groupAddr	the multicast group to be joined

Throws

IOException	may be thrown while joining a group

public void joinGroup(SocketAddress groupAddress, 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

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

Throws

IOException	will be thrown if address is not a multicast address
SecurityException	will be thrown if caller is not authorized to join group
IllegalArgumentException	will be through if groupAddr is null

public void leaveGroup(InetAddress groupAddr)

Remove the socket from the multicast group.

Parameters

groupAddr	the multicast group to be left

Throws

IOException	will be thrown if address is not a multicast address
SecurityException	will be thrown if caller is not authorized to join group
IllegalArgumentException	will be through if groupAddr is null

public void leaveGroup(SocketAddress groupAddress, NetworkInterface netInterface)

Remove the socket from the multicast group.

Parameters

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

Throws

IOException	will be thrown if address is not a multicast address
SecurityException	will be thrown if caller is not authorized to join group
IllegalArgumentException	will be through if groupAddr is null

public void send(DatagramPacket pack, byte ttl)

This method is deprecated. use MulticastSocket#setTimeToLive

Send the packet on this socket. The packet must satisfy the security policy before it may be sent.

Parameters

pack	the DatagramPacket to send
ttl	the TTL setting for this transmission, overriding the socket default

Throws

IOException	If a send error occurs.

public void setInterface(InetAddress addr)

Set the network address used by the socket. This is useful on multi-homed machines.

Parameters

addr	java.net.InetAddress the interface network address

Throws

SocketException	the exception may be thrown while setting the address

public void setLoopbackMode(boolean loop)

Set the IP_MULTICAST_LOOP socket option.

Parameters

loop	the socket IP_MULTICAST_LOOP option setting

Throws

SocketException	if the socket is closed or the option is invalid.

public void setNetworkInterface(NetworkInterface netInterface)

Set the network interface used by the socket. This is useful on multi-homed machines.

Parameters

netInterface	NetworkInterface the interface to be used

Throws

SocketException	the exception may be thrown while setting the address

public 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

Throws

IOException	The exception thrown while setting the TTL

public 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


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.net.MulticastSocket

See Also

Summary

Public Constructors

Public Methods

Methods inherited from class java.net.DatagramSocket

Methods inherited from class java.lang.Object

Details

Public Constructors

public MulticastSocket()

Throws

public MulticastSocket(int aPort)

Parameters

Throws

public MulticastSocket(SocketAddress localAddr)

Parameters

Throws

Public Methods

public InetAddress getInterface()

Returns

Throws

public boolean getLoopbackMode()

Returns

Throws

public NetworkInterface getNetworkInterface()

Returns

Throws

public byte getTTL()

Returns

Throws

See Also

public int getTimeToLive()

Returns

Throws

public void joinGroup(InetAddress groupAddr)

Parameters

Throws

public void joinGroup(SocketAddress groupAddress, NetworkInterface netInterface)

Parameters

Throws

public void leaveGroup(InetAddress groupAddr)

Parameters

Throws

public void leaveGroup(SocketAddress groupAddress, NetworkInterface netInterface)

Parameters

Throws

public void send(DatagramPacket pack, byte ttl)

Parameters

Throws

public void setInterface(InetAddress addr)

Parameters

Throws

public void setLoopbackMode(boolean loop)

Parameters

Throws

public void setNetworkInterface(NetworkInterface netInterface)

Parameters

Throws

public void setTTL(byte ttl)

Parameters

Throws

See Also

public void setTimeToLive(int ttl)

Parameters

Throws