org.scion.jpan

Class ScmpResponder

java.lang.Object

org.scion.jpan.ScmpResponder

All Implemented Interfaces:

AutoCloseable

public class ScmpResponder
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScmpResponder.Builder

Method Summary

Modifier and Type	Method and Description
void	close()
InetSocketAddress	getLocalAddress()
static ScmpResponder.Builder	newBuilder()
<T> void	setOption(SocketOption<T> option, T t)
Predicate<Scmp.EchoMessage>	setScmpEchoListener(Predicate<Scmp.EchoMessage> listener) Install a listener for echo messages.
Consumer<Scmp.ErrorMessage>	setScmpErrorListener(Consumer<Scmp.ErrorMessage> listener)
void	start() Install an SCMP echo responder.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static ScmpResponder.Builder newBuilder()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

setScmpErrorListener

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

setScmpEchoListener

public Predicate<Scmp.EchoMessage> setScmpEchoListener(Predicate<Scmp.EchoMessage> listener)

Install a listener for echo messages. The listener is called for every incoming echo request message. A response will be sent iff the listener returns 'true'. That means that any time spent in the listener counts towards the RTT of the echo request.

The listener will only be called for messages received during `setUpScmpEchoResponder()`.

Parameters:

listener - THe listener function

Returns:

Any previously installed listener or 'null' if none was installed.

setOption

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

Throws:

IOException

start

public void start()
           throws IOException

Install an SCMP echo responder. This method blocks until interrupted. While blocking, it will answer all valid SCMP echo requests.

SCMP requests can be monitored and intercepted through a listener, see setScmpEchoListener(Predicate).

This method blocks until close() is called.

Throws:

IOException - If an IO exception occurs.

getLocalAddress

public InetSocketAddress getLocalAddress()
                                  throws IOException

Throws:

IOException