org.scion.jpan

Class ScmpSenderAsync

java.lang.Object

org.scion.jpan.ScmpSenderAsync

All Implemented Interfaces:

AutoCloseable

public class ScmpSenderAsync
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScmpSenderAsync.Builder
static interface	ScmpSenderAsync.ResponseHandler

Method Summary

Modifier and Type	Method and Description
void	abortAll()
void	close()
ScmpSenderAsync.ResponseHandler	getHandler()
InetSocketAddress	getLocalAddress()
<T> T	getOption(SocketOption<T> option)
int	getTimeOut()
static ScmpSenderAsync.Builder	newBuilder(ScmpSenderAsync.ResponseHandler handler)
int	sendEcho(Path path, ByteBuffer payload) Sends a SCMP echo request along the specified path.
List<Integer>	sendTraceroute(Path path) Sends a SCMP traceroute request along the specified path.
int	sendTracerouteLast(Path path) Sends a SCMP traceroute request along the specified path.
<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.
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 ScmpSenderAsync.Builder newBuilder(ScmpSenderAsync.ResponseHandler handler)

abortAll

public void abortAll()

getHandler

public ScmpSenderAsync.ResponseHandler getHandler()

Returns:

The assigned response handler.

sendEcho

public int sendEcho(Path path,
                    ByteBuffer payload)
             throws IOException

Sends a SCMP echo request along the specified path.

After calling this method you may want to call abortAll() to abort potentially remaining timeout timers from outstanding responses.

Parameters:

path - The path to use.

payload - user data that is sent with the request

Returns:

The sequence ID.

Throws:

IOException - if an IO error occurs.

sendTraceroute

public List<Integer> sendTraceroute(Path path)
                             throws IOException

Sends a SCMP traceroute request along the specified path.

After calling this method you may want to call abortAll() to abort potentially remaining timeout timers from outstanding responses.

Parameters:

path - The path to use.

Returns:

A list of sequence IDs.

Throws:

IOException - if an IO error occurs.

sendTracerouteLast

public int sendTracerouteLast(Path path)
                       throws IOException

Sends a SCMP traceroute request along the specified path. A measurement will only be returned for the _last_ AS, i.e. the final destination AS.

After calling this method you may want to call abortAll() to abort potentially remaining timeout timers from outstanding responses.

Parameters:

path - The path to use.

Returns:

The sequence ID or -1 if the path is empty.

Throws:

IOException - if an IO error occurs.

setTimeOut

public void setTimeOut(int milliSeconds)

getTimeOut

public int getTimeOut()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

getOption

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

Throws:

IOException

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