Package com.ngrok

Interface Listener<C extends Connection>

Type Parameters:

C - the type of Connections this listener accepts

All Superinterfaces:

AutoCloseable, ListenerInfo

All Known Subinterfaces:

Listener.Edge, Listener.Endpoint

public interface Listener<C extends Connection>
extends ListenerInfo, AutoCloseable

Listener enables applications to handle incoming traffic proxied by ngrok. Each connection to ngrok is forwarded to an instance of a Listener for processing the implementation specific logic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Listener.Builder<L extends Listener>	Represents a builder that can create new Listener instances.
static interface	Listener.Edge	Represents an edge Listener.
static interface	Listener.Endpoint	Represents an endpoint Listener.

Method Summary

Modifier and Type	Method	Description
C	accept()	Waits for the next connection and returns it.
void	close()	Closes this Listener.

Methods inherited from interface com.ngrok.ListenerInfo

getForwardsTo, getId, getMetadata

Method Detail

accept

C accept()
  throws IOException

Waits for the next connection and returns it.

Returns:

the connection

Throws:

IOException - if an I/O error occurs

close

void close()
    throws IOException

Closes this Listener.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs