All Classes

Class	Description
AbstractSocketImpl	Abstract implementation of the SocketImpl interface.
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.
ConnectionInputStream	An input stream for reading data from Connection.
ConnectionOutputStream	An output stream for writing data to Connection.
ConnectionSocket	A socket for establishing a connection to a remote server.
ConnectionSocketImpl	An implementation of AbstractSocketImpl for establishing a socket connection to a remote server.
EdgeBuilder	A builder for creating an edge listener
EndpointBuilder<T extends EndpointBuilder<T>>	An abstract builder sharing common attributes of endpoint listener builders.
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.
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.Scheme	Represents the scheme for an HTTP listener.
Http.WebhookVerification	Represents webhook verification options for an HTTP listener.
HttpBuilder	A builder for creating a HTTP endpoint listener
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.
ListenerServerSocket	A server socket for accepting connections from a Listener.
ListenerSocketImpl	An implementation of the AbstractSocketImpl interface for accepting connections on a Listener
MetadataBuilder<T extends MetadataBuilder>	An abstract builder sharing common attributes of all listener builders.
NgrokConnector	A class representing a connector implementation for ngrok listeners.
NgrokEndpoint	A class representing an endpoint for ngrok connection.
NgrokException
ProxyProto	Enum representing the proxy protocol version.
Session	A session with the ngrok service.
Session.Builder	A builder for creating a session
Session.ClientInfo	Represents additional information about the client.
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.
TcpBuilder	A builder for creating a TCP endpoint listener
TlsBuilder	A builder for creating a TLS endpoint listener