org.scion.jpan

Class ScionDatagramSocket

java.lang.Object

java.net.DatagramSocket

org.scion.jpan.ScionDatagramSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class ScionDatagramSocket
extends DatagramSocket

A DatagramSocket that is SCION path aware. It can send and receive SCION packets.

Note: use of this class is discouraged in favor of org.scion.ScionDatagramChannel. The reason is that this class' API (InetAddress and DatagramPacket) cannot be extended to support SCION paths. As a consequence, a server needs to cache paths internally which requires memory and may cause exceptions if more connections (=paths) are managed than the configured thresholds allows.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScionDatagramSocket()
	ScionDatagramSocket(int port)
	ScionDatagramSocket(int port, InetAddress bindAddress)
protected	ScionDatagramSocket(ScionService service, DatagramChannel channel)
	ScionDatagramSocket(SocketAddress bindAddress)
protected	ScionDatagramSocket(SocketAddress bindAddress, ScionService service)

Method Summary

Modifier and Type	Method and Description
void	bind(SocketAddress address)
void	close()
void	connect(InetAddress address, int port)
void	connect(Path path) Connect to a destination using a specific path.
void	connect(SocketAddress address)
static ScionDatagramSocket	create(ScionService service) Creates a ScionDatagramSocket with a specific ScionService instance.
static ScionDatagramSocket	create(ScionService service, DatagramChannel channel)
static ScionDatagramSocket	create(SocketAddress bindAddress, ScionService service)
void	disconnect()
boolean	getBroadcast()
Path	getCachedPath(InetSocketAddress address) The DatagramSocket caches paths from received packets.
DatagramChannel	getChannel()
Path	getConnectionPath() Get the currently connected path.
InetAddress	getInetAddress()
InetAddress	getLocalAddress()
int	getLocalPort()
SocketAddress	getLocalSocketAddress()
<T> T	getOption(SocketOption<T> name)
int	getPathCacheCapacity() The DatagramSocket caches paths from received packets.
PathPolicy	getPathPolicy()
int	getPort()
int	getReceiveBufferSize()
SocketAddress	getRemoteSocketAddress()
boolean	getReuseAddress()
ScionDatagramChannel	getScionChannel() Deprecated. This method will be removed in a future version once getChannel() is implemented.
int	getSendBufferSize()
ScionService	getService()
int	getSoTimeout()
int	getTrafficClass()
boolean	isBound()
boolean	isClosed()
boolean	isConnected()
void	joinGroup(SocketAddress mcastaddr, NetworkInterface netIf) This method is currently not supported in SCION.
void	leaveGroup(SocketAddress mcastaddr, NetworkInterface netIf) This method is currently not supported in SCION.
void	receive(DatagramPacket packet)
void	send(DatagramPacket packet)
void	setBroadcast(boolean flag)
static void	setDatagramSocketImplFactory(DatagramSocketImplFactory factory)
<T> ScionDatagramSocket	setOption(SocketOption<T> name, T value)
void	setOverrideSourceAddress(InetSocketAddress overrideSourceAddress) Specify an source address override.
void	setPathCacheCapacity(int capacity) The DatagramSocket caches paths from received packets.
void	setPathPolicy(PathPolicy pathPolicy) Set the path policy.
void	setReceiveBufferSize(int size)
ScionDatagramSocket	setRemoteDispatcher(boolean hasDispatcher) Deprecated. Not required anymore, will be removed for 0.5.0
void	setReuseAddress(boolean flag)
void	setSendBufferSize(int size)
void	setSoTimeout(int timeOut)
void	setTrafficClass(int trafficClass)
Set<SocketOption<?>>	supportedOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScionDatagramSocket

public ScionDatagramSocket()
                    throws SocketException

Throws:

SocketException

ScionDatagramSocket

public ScionDatagramSocket(int port)
                    throws SocketException

Throws:

SocketException

ScionDatagramSocket

public ScionDatagramSocket(int port,
                           InetAddress bindAddress)
                    throws SocketException

Throws:

SocketException

ScionDatagramSocket

public ScionDatagramSocket(SocketAddress bindAddress)
                    throws SocketException

Throws:

SocketException

ScionDatagramSocket

protected ScionDatagramSocket(ScionService service,
                              DatagramChannel channel)
                       throws SocketException

Throws:

SocketException

ScionDatagramSocket

protected ScionDatagramSocket(SocketAddress bindAddress,
                              ScionService service)
                       throws SocketException

Throws:

SocketException

Method Detail

create

public static ScionDatagramSocket create(ScionService service)
                                  throws SocketException

Creates a ScionDatagramSocket with a specific ScionService instance. Under some circumstances the ScionService may be 'null', however, this is not recommended. See also ScionDatagramChannel.open(ScionService).

Parameters:

service - A ScionService or 'null'.

Returns:

a new socket.

Throws:

SocketException

create

public static ScionDatagramSocket create(ScionService service,
                                         DatagramChannel channel)
                                  throws SocketException

Throws:

SocketException

create

public static ScionDatagramSocket create(SocketAddress bindAddress,
                                         ScionService service)
                                  throws SocketException

Throws:

SocketException

setDatagramSocketImplFactory

public static void setDatagramSocketImplFactory(DatagramSocketImplFactory factory)
                                         throws IOException

Throws:

IOException

bind

public void bind(SocketAddress address)
          throws SocketException

Overrides:

bind in class DatagramSocket

Throws:

SocketException

connect

public void connect(Path path)

Connect to a destination using a specific path. See AbstractDatagramChannel.connect(Path) for details.

Parameters:

path - path to destination

See Also:

AbstractDatagramChannel.connect(Path)

connect

public void connect(InetAddress address,
                    int port)

Overrides:

connect in class DatagramSocket

connect

public void connect(SocketAddress address)
             throws SocketException

Overrides:

connect in class DatagramSocket

Throws:

SocketException

disconnect

public void disconnect()

Overrides:

disconnect in class DatagramSocket

isBound

public boolean isBound()

Overrides:

isBound in class DatagramSocket

isConnected

public boolean isConnected()

Overrides:

isConnected in class DatagramSocket

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class DatagramSocket

isClosed

public boolean isClosed()

Overrides:

isClosed in class DatagramSocket

getInetAddress

public InetAddress getInetAddress()

Overrides:

getInetAddress in class DatagramSocket

getPort

public int getPort()

Overrides:

getPort in class DatagramSocket

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Overrides:

getRemoteSocketAddress in class DatagramSocket

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Overrides:

getLocalSocketAddress in class DatagramSocket

send

public void send(DatagramPacket packet)
          throws IOException

Overrides:

send in class DatagramSocket

Throws:

IOException

receive

public void receive(DatagramPacket packet)
             throws IOException

Overrides:

receive in class DatagramSocket

Throws:

IOException

getLocalAddress

public InetAddress getLocalAddress()

Overrides:

getLocalAddress in class DatagramSocket

getLocalPort

public int getLocalPort()

Overrides:

getLocalPort in class DatagramSocket

getBroadcast

public boolean getBroadcast()
                     throws SocketException

Overrides:

getBroadcast in class DatagramSocket

Throws:

SocketException

setBroadcast

public void setBroadcast(boolean flag)
                  throws SocketException

Overrides:

setBroadcast in class DatagramSocket

Throws:

SocketException

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Overrides:

getReuseAddress in class DatagramSocket

Throws:

SocketException

setReuseAddress

public void setReuseAddress(boolean flag)
                     throws SocketException

Overrides:

setReuseAddress in class DatagramSocket

Throws:

SocketException

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Overrides:

getReceiveBufferSize in class DatagramSocket

Throws:

SocketException

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Overrides:

setReceiveBufferSize in class DatagramSocket

Throws:

SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Overrides:

getSendBufferSize in class DatagramSocket

Throws:

SocketException

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Overrides:

setSendBufferSize in class DatagramSocket

Throws:

SocketException

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Overrides:

getSoTimeout in class DatagramSocket

Throws:

SocketException

setSoTimeout

public void setSoTimeout(int timeOut)
                  throws SocketException

Overrides:

setSoTimeout in class DatagramSocket

Throws:

SocketException

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Overrides:

getTrafficClass in class DatagramSocket

Throws:

SocketException

setTrafficClass

public void setTrafficClass(int trafficClass)
                     throws SocketException

Overrides:

setTrafficClass in class DatagramSocket

Throws:

SocketException

getChannel

public DatagramChannel getChannel()

Overrides:

getChannel in class DatagramSocket

setOption

public <T> ScionDatagramSocket setOption(SocketOption<T> name,
                                         T value)
                                  throws IOException

Throws:

IOException

getOption

public <T> T getOption(SocketOption<T> name)
                throws IOException

Throws:

IOException

supportedOptions

public Set<SocketOption<?>> supportedOptions()

joinGroup

public void joinGroup(SocketAddress mcastaddr,
                      NetworkInterface netIf)

This method is currently not supported in SCION. It is public because some JDKs make this method public.

Parameters:

mcastaddr - multicast address

netIf - network interface

Throws:

IOException - in case of IO error

leaveGroup

public void leaveGroup(SocketAddress mcastaddr,
                       NetworkInterface netIf)

This method is currently not supported in SCION. It is public because some JDKs make this method public.

Parameters:

mcastaddr - multicast address

netIf - network interface

Throws:

IOException - in case of IO error

getConnectionPath

public Path getConnectionPath()

Get the currently connected path. The connected path is set during connect(Path) and may be refreshed when expired.

Returns:

the current Path or `null` if not path is connected.

See Also:

AbstractDatagramChannel.getConnectionPath()

getCachedPath

public Path getCachedPath(InetSocketAddress address)

The DatagramSocket caches paths from received packets. These are used to send responses to these packets. The method getCachedPath() looks up the path (if any) for the given address. Note that the cache size is limited, see setPathCacheCapacity(int).

Returns:

the cached Path or `null` if not path is found.

See Also:

setPathCacheCapacity(int)

setPathCacheCapacity

public void setPathCacheCapacity(int capacity)

The DatagramSocket caches paths from received packets. These are used to send responses to these packets. The method setPathCacheCapacity() sets the size of the path cache. The default size is 100.

See Also:

getCachedPath(java.net.InetSocketAddress), getPathCacheCapacity()

getPathCacheCapacity

public int getPathCacheCapacity()

The DatagramSocket caches paths from received packets. These are used to send responses to these packets. The method getPathCacheCapacity() gets the size of the path cache.

Returns:

the size of the path cache.

See Also:

setPathCacheCapacity(int)

getScionChannel

@Deprecated
public ScionDatagramChannel getScionChannel()

Deprecated. This method will be removed in a future version once getChannel() is implemented.

Returns:

The associated DatagramChannel

getService

public ScionService getService()

Returns:

The currently associated ScionService for this socket. This usually returns 'null' for server side sockets because the service is only created for looking up SCION addresses and ISD/AS codes, which should not be necessary for a server.

See Also:

AbstractDatagramChannel.getService()

getPathPolicy

public PathPolicy getPathPolicy()

setPathPolicy

public void setPathPolicy(PathPolicy pathPolicy)
                   throws IOException

Set the path policy. The default path policy is set in PathPolicy.DEFAULT. If the socket is connected, this method will request a new path using the new policy.

After initially setting the path policy, it is used to request a new path during write() and send() whenever a path turns out to be close to expiration.

Parameters:

pathPolicy - the new path policy

Throws:

IOException

See Also:

PathPolicy.DEFAULT, AbstractDatagramChannel.setPathPolicy(PathPolicy)

setRemoteDispatcher

@Deprecated
public ScionDatagramSocket setRemoteDispatcher(boolean hasDispatcher)

Deprecated. Not required anymore, will be removed for 0.5.0

Assume that the destination host uses a dispatcher.

See AbstractDatagramChannel.configureRemoteDispatcher(boolean).

Parameters:

hasDispatcher - Set to 'true' if remote end-host uses a dispatcher and requires using port 30041.

See Also:

AbstractDatagramChannel.configureRemoteDispatcher(boolean)

setOverrideSourceAddress

public void setOverrideSourceAddress(InetSocketAddress overrideSourceAddress)

Specify an source address override. See AbstractDatagramChannel.setOverrideSourceAddress(InetSocketAddress).

Parameters:

overrideSourceAddress - Override address