Package com.github.alexdlaird.ngrok

Class NgrokClient

java.lang.Object

com.github.alexdlaird.ngrok.NgrokClient

public class NgrokClient
extends java.lang.Object

A client for interacting with ngrok, its binary, and its APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NgrokClient.Builder

Method Summary

Modifier and Type	Method	Description
Tunnel	connect(CreateTunnel createTunnel)
void	disconnect(java.lang.String publicUrl)
NgrokProcess	getNgrokProcess()
Tunnels	getTunnels()
void	kill()

Methods inherited from class java.lang.Object

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

Method Detail

connect

public Tunnel connect(CreateTunnel createTunnel)
               throws java.io.IOException,
                      java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

disconnect

public void disconnect(java.lang.String publicUrl)
                throws java.io.IOException,
                       java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

getTunnels

public Tunnels getTunnels()

kill

public void kill()
          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

getNgrokProcess

public NgrokProcess getNgrokProcess()