Class Listener

Close the listener.

This is an RPC call that must be .awaited. It is equivalent to calling Session::close_listener with this listener's ID.

Forward incoming listener connections. This can be either a TCP address or a file socket path. For file socket paths on Linux/Darwin, addr can be a unix domain socket path, e.g. "/tmp/ngrok.sock" On Windows, addr can be a named pipe, e.e. "\\.\pipe\an_ngrok_pipe

Returns a human-readable string presented in the ngrok dashboard and the API. Use the HttpListenerBuilder.forwardsTo, TcpListenerBuilder.forwardsTo, etc. to set this value explicitly.

To automatically forward connections, you can use HttpListenerBuilder.listenAndForward or HttpListenerBuilder.listenAndServe on the Listener Builder. These methods will also set this forwardsTo value.

Returns a listener's unique ID.

Wait for the forwarding task to exit.

The labels this listener was started with.

Returns the arbitrary metadata string for this listener.

The protocol of the endpoint that this listener backs.

The URL that this listener backs.