Home How it Works Android APIMiner IDE Version More Info

to top

Summary: Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

MulticastSocket

extends DatagramSocket

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

Class Overview

This class implements a multicast socket for sending and receiving IP multicast datagram packets.

Summary

Public Constructors
	MulticastSocket() Constructs a multicast socket, bound to any available port on the local host.
	MulticastSocket(int port) Constructs a multicast socket, bound to the specified `port` on the local host.
	MulticastSocket( SocketAddress localAddress) Constructs a `MulticastSocket` bound to the address and port specified by `localAddress`, or an unbound `MulticastSocket` if `localAddress == null`.

Public Methods
InetAddress	getInterface() Returns an address of the outgoing network interface used by this socket.
boolean	getLoopbackMode() Returns true if multicast loopback is disabled.
NetworkInterface	getNetworkInterface() Returns the outgoing network interface used by this socket.
byte	getTTL() This method was deprecated in API level 1. Replaced by `getTimeToLive()`
int	getTimeToLive() Returns the time-to-live (TTL) for multicast packets sent on this socket.
void	joinGroup( SocketAddress groupAddress, NetworkInterface netInterface) Adds this socket to the specified multicast group.
void	joinGroup( InetAddress groupAddr) Adds this socket to the specified multicast group.
void	leaveGroup( SocketAddress groupAddress, NetworkInterface netInterface) Removes this socket from the specified multicast group.
void	leaveGroup( InetAddress groupAddr) Removes this socket from the specified multicast group.
void	send( DatagramPacket packet, byte ttl) This method was deprecated in API level 1. use `setTimeToLive(int)`.
void	setInterface( InetAddress address) Sets the outgoing network interface used by this socket.
void	setLoopbackMode(boolean disable) Disables multicast loopback if `disable == true`.
void	setNetworkInterface( NetworkInterface networkInterface) Sets the outgoing network interface used by this socket to the given `networkInterface`.
void	setTTL(byte ttl) This method was deprecated in API level 1. Replaced by `setTimeToLive(int)`
void	setTimeToLive(int ttl) Sets the time-to-live (TTL) for multicast packets sent on this socket.

[Expand]

Inherited Methods

From class java.net.DatagramSocket

void	bind( SocketAddress localAddr) Binds this socket to the local address and port specified by `localAddr`.
void	close() Closes this UDP datagram socket and all possibly associated channels.
void	connect( SocketAddress peer) Connects this datagram socket to the address and port specified by `peer`.
void	connect( InetAddress address, int port) Connects this datagram socket to the specific `address` and `port`.
void	disconnect() Disconnects this UDP datagram socket from the remote host.
boolean	getBroadcast() Gets the state of the socket option `SocketOptions.SO_BROADCAST`.
DatagramChannel	getChannel() Returns this socket's `DatagramChannel`, if one exists.
InetAddress	getInetAddress() Gets the `InetAddress` instance representing the remote address to which this UDP datagram socket is connected.
InetAddress	getLocalAddress() Gets the `InetAddress` instance representing the bound local address of this UDP datagram socket.
int	getLocalPort() Gets the local port which this socket is bound to.
SocketAddress	getLocalSocketAddress() Returns the `SocketAddress` this socket is bound to, or null for an unbound socket.
int	getPort() Gets the remote port which this socket is connected to.
synchronized int	getReceiveBufferSize() Returns this socket's `receive buffer size`.
SocketAddress	getRemoteSocketAddress() Returns the `SocketAddress` this socket is connected to, or null for an unconnected socket.
boolean	getReuseAddress() Gets the state of the socket option `SocketOptions.SO_REUSEADDR`.
synchronized int	getSendBufferSize() Returns this socket's `send buffer size`.
synchronized int	getSoTimeout() Gets the socket `receive timeout`.
int	getTrafficClass() Returns this socket's setting.
boolean	isBound() Returns true if this socket is bound to a local address.
boolean	isClosed() Gets the state of this socket.
boolean	isConnected() Returns true if this datagram socket is connected to a remote address.
synchronized void	receive( DatagramPacket pack) Receives a packet from this socket and stores it in the argument `pack`.
void	send( DatagramPacket pack) Sends a packet over this socket.
void	setBroadcast(boolean broadcast) Sets the socket option `SocketOptions.SO_BROADCAST`.
synchronized static void	setDatagramSocketImplFactory( DatagramSocketImplFactory fac) Sets the socket implementation factory.
synchronized void	setReceiveBufferSize(int size) Sets this socket's `receive buffer size`.
void	setReuseAddress(boolean reuse) Sets the socket option `SocketOptions.SO_REUSEADDR`.
synchronized void	setSendBufferSize(int size) Sets this socket's `send buffer size`.
synchronized void	setSoTimeout(int timeout) Sets the `read timeout` in milliseconds for this socket.
void	setTrafficClass(int value) Sets the value for every packet sent by this socket.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public MulticastSocket ()

Added in API level 1

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

Throws

IOException	if an error occurs.

public MulticastSocket (int port)

Added in API level 1

Constructs a multicast socket, bound to the specified port on the local host.

Throws

IOException	if an error occurs.

public MulticastSocket (SocketAddress localAddress)

Added in API level 1

Constructs a MulticastSocket bound to the address and port specified by localAddress, or an unbound MulticastSocket if localAddress == null.

Throws

IllegalArgumentException	if `localAddress` is not supported (because it's not an `InetSocketAddress`, say).
IOException	if an error occurs.

Public Methods

public InetAddress getInterface ()

Added in API level 1

Returns an address of the outgoing network interface used by this socket. To avoid inherent unpredictability, new code should use getNetworkInterface() instead.

Throws

SocketException	if an error occurs.

public boolean getLoopbackMode ()

Added in API level 1

Returns true if multicast loopback is disabled. See IP_MULTICAST_LOOP, and note that the sense of this is the opposite of the underlying Unix IP_MULTICAST_LOOP.

Throws

SocketException	if an error occurs.

public NetworkInterface getNetworkInterface ()

Added in API level 1

Returns the outgoing network interface used by this socket.

Throws

SocketException	if an error occurs.

public byte getTTL ()

Added in API level 1

This method was deprecated in API level 1.
Replaced by getTimeToLive()

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

Throws

IOException	if an error occurs.

public int getTimeToLive ()

Added in API level 1

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

Throws

IOException	if an error occurs.

public void joinGroup (SocketAddress groupAddress, NetworkInterface netInterface)

Added in API level 1

Adds this socket to the specified 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 only once.

Parameters

groupAddress	the multicast group to be joined.
netInterface	the network interface on which the datagram packets will be received.

Throws

IOException	if the specified address is not a multicast address.
IllegalArgumentException	if no multicast group is specified.

public void joinGroup (InetAddress groupAddr)

Added in API level 1

Adds this socket to the specified 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 only once.

Parameters

groupAddr	the multicast group to be joined.

Throws

IOException	if an error occurs.

public void leaveGroup (SocketAddress groupAddress, NetworkInterface netInterface)

Added in API level 1

Removes this socket from the specified multicast group.

Parameters

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

Throws

IOException	if the specified group address is not a multicast address.
IllegalArgumentException	if `groupAddress` is `null`.

public void leaveGroup (InetAddress groupAddr)

Added in API level 1

Removes this socket from the specified multicast group.

Parameters

groupAddr	the multicast group to be left.

Throws

NullPointerException	if `groupAddr` is `null`.
IOException	if the specified group address is not a multicast address.

public void send (DatagramPacket packet, byte ttl)

Added in API level 1

This method was deprecated in API level 1.
use setTimeToLive(int).

Sends the given packet on this socket, using the given ttl. This method is deprecated because it modifies the TTL socket option for this socket twice on each call.

Throws

IOException	if an error occurs.

public void setInterface (InetAddress address)

Added in API level 1

Sets the outgoing network interface used by this socket. The interface used is the first interface found to have the given address. To avoid inherent unpredictability, new code should use getNetworkInterface() instead.

Throws

SocketException	if an error occurs.

public void setLoopbackMode (boolean disable)

Added in API level 1

Disables multicast loopback if disable == true. See IP_MULTICAST_LOOP, and note that the sense of this is the opposite of the underlying Unix IP_MULTICAST_LOOP.

Throws

SocketException	if an error occurs.

public void setNetworkInterface (NetworkInterface networkInterface)

Added in API level 1

Sets the outgoing network interface used by this socket to the given networkInterface.

Throws

SocketException	if an error occurs.

public void setTTL (byte ttl)

Added in API level 1

This method was deprecated in API level 1.
Replaced by setTimeToLive(int)

Sets the time-to-live (TTL) for multicast packets sent on this socket. Valid TTL values are between 0 and 255 inclusive.

Throws

IOException	if an error occurs.

public void setTimeToLive (int ttl)

Added in API level 1

Sets the time-to-live (TTL) for multicast packets sent on this socket. Valid TTL values are between 0 and 255 inclusive.

Throws

IOException	if an error occurs.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Enums

Exceptions

MulticastSocket

Class Overview

See Also

Summary

Public Constructors

public MulticastSocket ()

Throws

public MulticastSocket (int port)

Throws

public MulticastSocket (SocketAddress localAddress)

Throws

Public Methods

public InetAddress getInterface ()

Throws

public boolean getLoopbackMode ()

Throws

public NetworkInterface getNetworkInterface ()

Throws

public byte getTTL ()

Throws

public int getTimeToLive ()

Throws

public void joinGroup (SocketAddress groupAddress, NetworkInterface netInterface)

Parameters

Throws

public void joinGroup (InetAddress groupAddr)

Parameters

Throws

public void leaveGroup (SocketAddress groupAddress, NetworkInterface netInterface)

Parameters

Throws

public void leaveGroup (InetAddress groupAddr)

Parameters

Throws

public void send (DatagramPacket packet, byte ttl)

Throws

public void setInterface (InetAddress address)

Throws

public void setLoopbackMode (boolean disable)

Throws

public void setNetworkInterface (NetworkInterface networkInterface)

Throws

public void setTTL (byte ttl)

Throws

public void setTimeToLive (int ttl)

Throws