org.scion.jpan

Class ScmpSender

java.lang.Object

org.scion.jpan.ScmpSender

All Implemented Interfaces:

AutoCloseable

public class ScmpSender
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScmpSender.Builder

Method Summary

Modifier and Type	Method and Description
void	close()
InetSocketAddress	getLocalAddress()
int	getTimeOut()
static ScmpSender.Builder	newBuilder()
Scmp.EchoMessage	sendEchoRequest(Path path, ByteBuffer data) Sends a SCMP echo request to the connected destination.
List<Scmp.TracerouteMessage>	sendTracerouteRequest(Path path) Sends a SCMP traceroute request to the connected destination.
<T> void	setOption(SocketOption<T> option, T t) This is currently only useful for ScionSocketOptions.SCION_API_THROW_PARSER_FAILURE.
void	setOverrideSourceAddress(InetSocketAddress overrideSourceAddress) Specify a source address override.
Consumer<Scmp.ErrorMessage>	setScmpErrorListener(Consumer<Scmp.ErrorMessage> listener)
void	setTimeOut(int milliSeconds)

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static ScmpSender.Builder newBuilder()

sendEchoRequest

public Scmp.EchoMessage sendEchoRequest(Path path,
                                        ByteBuffer data)
                                 throws IOException

Sends a SCMP echo request to the connected destination.

Parameters:

path - The path to use.

data - user data that is sent with the request

Returns:

A SCMP result. If a reply is received, the result contains the reply and the time in milliseconds that the reply took. If the request timed out, the result contains no message and the time is equal to the time-out duration.

Throws:

IOException - if an IO error occurs or if an SCMP error is received.

sendTracerouteRequest

public List<Scmp.TracerouteMessage> sendTracerouteRequest(Path path)
                                                   throws IOException

Sends a SCMP traceroute request to the connected destination.

Parameters:

path - The path to use.

Returns:

A list of SCMP results, one for each hop on the route. For every reply received, the result contains the reply and the time in milliseconds that the reply took. If the request timed out, the result contains no message and the time is equal to the time-out duration. If a request times out, the traceroute is aborted.

Throws:

IOException - if an IO error occurs or if an SCMP error is received.

setTimeOut

public void setTimeOut(int milliSeconds)

getTimeOut

public int getTimeOut()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

setScmpErrorListener

public Consumer<Scmp.ErrorMessage> setScmpErrorListener(Consumer<Scmp.ErrorMessage> listener)

setOption

public <T> void setOption(SocketOption<T> option,
                          T t)
                   throws IOException

This is currently only useful for ScionSocketOptions.SCION_API_THROW_PARSER_FAILURE.

Type Parameters:

T - option type

Parameters:

option - option

t - value

Throws:

IOException - in case of IO error

getLocalAddress

public InetSocketAddress getLocalAddress()
                                  throws IOException

Throws:

IOException

setOverrideSourceAddress

public void setOverrideSourceAddress(InetSocketAddress overrideSourceAddress)

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

Parameters:

overrideSourceAddress - Override address