Package com.ngrok

Interface Summary

Interface	Description
Connection	Represents a connection established over a listener.
Connection.Edge	Represents a connection established over an edge listener
Connection.Endpoint	Represents a connection establish over an endpoint listener.
Forwarder	Forwarder is a type of listener which automatically forwards the incoming Connections to another url
Forwarder.Builder<F extends Forwarder>	Represents a builder that can create new Forwarder instances.
Forwarder.Edge	Represents an edge Forwarder
Forwarder.Endpoint	Represents an endpoint Forwarder
Http	A set of data classes to support creation of HTTP endpoint listeners.
Listener<C extends Connection>	Listener enables applications to handle incoming traffic proxied by ngrok.
Listener.Builder<L extends Listener>	Represents a builder that can create new Listener instances.
Listener.Edge	Represents an edge Listener.
Listener.Endpoint	Represents an endpoint Listener.
ListenerInfo	Represents information about a running Listener.
ListenerInfo.Edge	Represents information about a running Listener.Edge.
ListenerInfo.Endpoint	Represents information about a running Listener.Endpoint.
Session	A session with the ngrok service.
Session.CommandHandler	Provides a way to listen for specific server side events.
Session.HeartbeatHandler	Provides a way to monitor current session's heartbeats and disconnects.

Class Summary

Class	Description
EdgeBuilder	A builder for creating an edge listener
EndpointBuilder<T extends EndpointBuilder<T>>	An abstract builder sharing common attributes of endpoint listener builders.
Http.BasicAuth	Represents basic authentication options for an HTTP listener.
Http.Header	Represents an HTTP header.
Http.OAuth	Represents OAuth configuration for an HTTP listener.
Http.OIDC	Represents OIDC configuration for an HTTP listener.
Http.WebhookVerification	Represents webhook verification options for an HTTP listener.
HttpBuilder	A builder for creating a HTTP endpoint listener
MetadataBuilder<T extends MetadataBuilder>	An abstract builder sharing common attributes of all listener builders.
Session.Builder	A builder for creating a session
Session.ClientInfo	Represents additional information about the client.
TcpBuilder	A builder for creating a TCP endpoint listener
TlsBuilder	A builder for creating a TLS endpoint listener

Enum Summary

Enum	Description
Http.Scheme	Represents the scheme for an HTTP listener.
ProxyProto	Enum representing the proxy protocol version.

Exception Summary

Exception	Description
NgrokException