A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages

A

AbstractSocketImpl - Class in com.ngrok.net

Abstract implementation of the SocketImpl interface.

AbstractSocketImpl() - Constructor for class com.ngrok.net.AbstractSocketImpl

accept() - Method in interface com.ngrok.Listener

Waits for the next connection and returns it.

accept() - Method in class com.ngrok.net.ListenerServerSocket

Accepts a connection to the server socket.

accept(int) - Method in class com.ngrok.jetty.NgrokConnector

Accepts a new connection on this ngrok connector.

accept(SocketImpl) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.accept(SocketImpl)

accept(SocketImpl) - Method in class com.ngrok.net.ListenerSocketImpl

Accepts a listener connection to the socket.

addClientInfo(String, String) - Method in class com.ngrok.Session.Builder

Adds a client info to the list of client info objects for this builder

addClientInfo(String, String, String) - Method in class com.ngrok.Session.Builder

Adds a client info to the list of client info objects for this builder

addRequestHeader(String, String) - Method in class com.ngrok.HttpBuilder

Adds a header to the list of added request headers for this HTTP endpoint.

addResponseHeader(String, String) - Method in class com.ngrok.HttpBuilder

Adds a header to the list of added response headers for this HTTP endpoint.

allowCIDR(String) - Method in class com.ngrok.EndpointBuilder

Adds a CIDR to the list of allowed CIDRs for this endpoint.

allowDomain(String) - Method in class com.ngrok.Http.OAuth

Sets the domain allowed by the OAuth.

allowDomain(String) - Method in class com.ngrok.Http.OIDC

Sets the domain that will be allowed by OIDC.

allowEmail(String) - Method in class com.ngrok.Http.OAuth

Sets the email address allowed by OAuth.

allowEmail(String) - Method in class com.ngrok.Http.OIDC

Sets the email address that will be allowed by OIDC.

available() - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.available()

B

BasicAuth(String, String) - Constructor for class com.ngrok.Http.BasicAuth

Constructs a new set of basic authentication options with the specified username and password.

basicAuthOptions(Http.BasicAuth) - Method in class com.ngrok.HttpBuilder

Sets basic authentication for this HTTP endpoint.

bind(InetAddress, int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.bind(InetAddress, int)

C

caCert(byte[]) - Method in class com.ngrok.Session.Builder

Sets the ca certificate for this builder

circuitBreaker(double) - Method in class com.ngrok.HttpBuilder

Sets the circuit breaker value for this HTTP endpoint.

client(String, String) - Method in class com.ngrok.Http.OAuth

Sets the client ID and client secret for OAuth.

ClientInfo(String, String, String) - Constructor for class com.ngrok.Session.ClientInfo

Creates a new client information with a given type, version and comment.

close() - Method in interface com.ngrok.Connection

Closes this connection and releases any system resources associated with it.

close() - Method in interface com.ngrok.Forwarder

Closes this Forwarder.

close() - Method in interface com.ngrok.Listener

Closes this Listener.

close() - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.close()

close() - Method in interface com.ngrok.Session

closeForwarder(String) - Method in interface com.ngrok.Session

Closes a forwarder by its ID

closeListener(String) - Method in interface com.ngrok.Session

Closes a listener by its ID

com.ngrok - package com.ngrok

com.ngrok.jetty - package com.ngrok.jetty

com.ngrok.net - package com.ngrok.net

compression() - Method in class com.ngrok.HttpBuilder

Enables HTTP response compression for this HTTP endpoint.

connect() - Method in class com.ngrok.Session.Builder

Connects a session with the current Session.Builder

connect(Session.Builder) - Static method in interface com.ngrok.Session

Connects a session with specified Session.Builder

connect(String, int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.connect(String, int)

connect(InetAddress, int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.connect(InetAddress, int)

connect(SocketAddress, int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.connect(SocketAddress, int)

connection - Variable in class com.ngrok.net.ConnectionSocketImpl

Connection - Interface in com.ngrok

Represents a connection established over a listener.

Connection.Edge - Interface in com.ngrok

Represents a connection established over an edge listener

Connection.Endpoint - Interface in com.ngrok

Represents a connection establish over an endpoint listener.

ConnectionInputStream - Class in com.ngrok.net

An input stream for reading data from Connection.

ConnectionInputStream(Connection, int) - Constructor for class com.ngrok.net.ConnectionInputStream

Creates a new input stream for the given connection with the specified buffer size.

ConnectionOutputStream - Class in com.ngrok.net

An output stream for writing data to Connection.

ConnectionOutputStream(Connection, int) - Constructor for class com.ngrok.net.ConnectionOutputStream

Creates a new output stream for the given connection, backed by a direct buffer with the specified buffer size.

ConnectionSocket - Class in com.ngrok.net

A socket for establishing a connection to a remote server.

ConnectionSocket() - Constructor for class com.ngrok.net.ConnectionSocket

Creates a new connection socket.

ConnectionSocketImpl - Class in com.ngrok.net

An implementation of AbstractSocketImpl for establishing a socket connection to a remote server.

ConnectionSocketImpl() - Constructor for class com.ngrok.net.ConnectionSocketImpl

create(boolean) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.create(boolean)

D

denyCIDR(String) - Method in class com.ngrok.EndpointBuilder

Adds a CIDR to the list of denied CIDRs for this endpoint.

domain(String) - Method in class com.ngrok.HttpBuilder

Sets the domain to request for this HTTP endpoint.

domain(String) - Method in class com.ngrok.TlsBuilder

Sets the domain to request for this TLS endpoint.

doStart() - Method in class com.ngrok.jetty.NgrokConnector

Starts this ngrok connector.

doStop() - Method in class com.ngrok.jetty.NgrokConnector

Stops this ngrok connector.

E

edge() - Method in interface com.ngrok.Session

Creates a new EdgeBuilder associated with this session.

EdgeBuilder - Class in com.ngrok

A builder for creating an edge listener

EdgeBuilder(Session) - Constructor for class com.ngrok.EdgeBuilder

Creates a new EdgeBuilder with a given session.

EndpointBuilder<T extends EndpointBuilder<T>> - Class in com.ngrok

An abstract builder sharing common attributes of endpoint listener builders.

EndpointBuilder() - Constructor for class com.ngrok.EndpointBuilder

F

fill(ByteBuffer) - Method in class com.ngrok.jetty.NgrokEndpoint

Fills the endpoint with data from the connection.

flush() - Method in class com.ngrok.net.ConnectionOutputStream

Flushes the output stream, forcing any buffered output bytes to be written out.

flush(ByteBuffer...) - Method in class com.ngrok.jetty.NgrokEndpoint

Flushes the endpoint with data from the connection.

forward(URL) - Method in class com.ngrok.EdgeBuilder

forward(URL) - Method in interface com.ngrok.Forwarder.Builder

Start listening and forwarding connections to given url.

forward(URL) - Method in class com.ngrok.HttpBuilder

forward(URL) - Method in class com.ngrok.TcpBuilder

forward(URL) - Method in class com.ngrok.TlsBuilder

forwardEdge(EdgeBuilder, URL) - Method in interface com.ngrok.Session

Configures and starts a Forwarder.Edge

Forwarder - Interface in com.ngrok

Forwarder is a type of listener which automatically forwards the incoming Connections to another url

Forwarder.Builder<F extends Forwarder> - Interface in com.ngrok

Represents a builder that can create new Forwarder instances.

Forwarder.Edge - Interface in com.ngrok

Represents an edge Forwarder

Forwarder.Endpoint - Interface in com.ngrok

Represents an endpoint Forwarder

forwardHttp(HttpBuilder, URL) - Method in interface com.ngrok.Session

Configures and starts a HTTP Forwarder.Endpoint

forwardsTo(String) - Method in class com.ngrok.MetadataBuilder

Sets the forwarding information for this endpoint.

forwardTcp(TcpBuilder, URL) - Method in interface com.ngrok.Session

Configures and starts a TCP Forwarder.Endpoint

forwardTls(TlsBuilder, URL) - Method in interface com.ngrok.Session

Configures and starts a TLS Forwarder.Endpoint

G

getAllowCIDR() - Method in class com.ngrok.EndpointBuilder

Returns a list of strings representing allowed CIDR addresses for this endpoint.

getAllowDomain() - Method in class com.ngrok.Http.OIDC

Returns the domain to be allowed by OIDC.

getAllowDomains() - Method in class com.ngrok.Http.OAuth

Returns the domain to be allowed by OAuth.

getAllowEmail() - Method in class com.ngrok.Http.OIDC

Returns the email address to be allowed by OIDC.

getAllowEmails() - Method in class com.ngrok.Http.OAuth

Returns the email address to be allowed by OAuth.

getAuthtoken() - Method in class com.ngrok.Session.Builder

Returns the ngrok authtoken associated with this builder.

getBasicAuth() - Method in class com.ngrok.HttpBuilder

Returns the basic authentication options for this HTTP endpoint.

getCaCert() - Method in class com.ngrok.Session.Builder

Returns the certificate for this builder.

getCircuitBreaker() - Method in class com.ngrok.HttpBuilder

Returns the circuit breaker value for this HTTP endpoint.

getClientId() - Method in class com.ngrok.Http.OAuth

Returns the client ID for OAuth.

getClientId() - Method in class com.ngrok.Http.OIDC

Returns the client ID for OIDC.

getClientInfos() - Method in class com.ngrok.Session.Builder

Returns the list of client info objects to add for this builder

getClientSecret() - Method in class com.ngrok.Http.OAuth

Returns the client secret for OAuth.

getClientSecret() - Method in class com.ngrok.Http.OIDC

Returns the client secret for OIDC.

getCode() - Method in exception com.ngrok.NgrokException

getComments() - Method in class com.ngrok.Session.ClientInfo

Returns the comments for this client.

getDenyCIDR() - Method in class com.ngrok.EndpointBuilder

Returns a list of strings representing denied CIDR addresses for this endpoint.

getDetails() - Method in exception com.ngrok.NgrokException

getDomain() - Method in class com.ngrok.HttpBuilder

Returns the domain on this HTTP endpoint.

getDomain() - Method in class com.ngrok.TlsBuilder

Returns the domain to request for this TLS endpoint.

getEdgeType() - Method in interface com.ngrok.Connection.Edge

Returns the edge type for this connection.

getForwardsTo() - Method in interface com.ngrok.ListenerInfo

Returns the target of that listener

getForwardsTo() - Method in class com.ngrok.MetadataBuilder

Returns the forwarding information for this endpoint.

getHeartbeatInterval() - Method in class com.ngrok.Session.Builder

Returns the heartbeat interval for this builder

getHeartbeatTolerance() - Method in class com.ngrok.Session.Builder

Returns the heartbeat tolerance for this builder

getId() - Method in interface com.ngrok.ListenerInfo

Returns the id associated with this listener

getId() - Method in interface com.ngrok.Session

Returns the ID of this session

getInetAddress() - Method in class com.ngrok.net.ConnectionSocket

Returns the InetAddress of the remote endpoint of this socket.

getInputStream() - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.getInputStream()

getInputStream() - Method in class com.ngrok.net.ConnectionSocketImpl

Creates and returns a ConnectionInputStream for reading data from the connection.

getIssuerUrl() - Method in class com.ngrok.Http.OIDC

Returns the issuer URL for OIDC.

getLabels() - Method in class com.ngrok.EdgeBuilder

Returns the label map for this builder.

getLabels() - Method in interface com.ngrok.ListenerInfo.Edge

Returns the labels associated with this listener.

getLocalSocketAddress() - Method in class com.ngrok.jetty.NgrokEndpoint

getMetadata() - Method in interface com.ngrok.ListenerInfo

Returns the metadata associated with this listener

getMetadata() - Method in class com.ngrok.MetadataBuilder

Returns the metadata for this endpoint.

getMetadata() - Method in class com.ngrok.Session.Builder

Returns the metadata for this builder.

getMetadata() - Method in interface com.ngrok.Session

Returns the metadata of this session

getMutualTLSCA() - Method in class com.ngrok.HttpBuilder

Returns the certificates to use for client authentication for this HTTP endpoint.

getMutualTLSCA() - Method in class com.ngrok.TlsBuilder

Returns the certificates to use for client authentication for this TLS endpoint.

getName() - Method in class com.ngrok.Http.Header

Returns the name of the header.

getOauth() - Method in class com.ngrok.HttpBuilder

Returns the OAuth options for this HTTP endpoint.

getOidc() - Method in class com.ngrok.HttpBuilder

Returns the OIDC options for this HTTP endpoint.

getOption(int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketOptions.getOption(int)

getOutputStream() - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.getOutputStream()

getOutputStream() - Method in class com.ngrok.net.ConnectionSocketImpl

Creates and returns a ConnectionOutputStream for writing data to the connection.

getPassword() - Method in class com.ngrok.Http.BasicAuth

Returns the password for basic auth.

getPolicy() - Method in class com.ngrok.EndpointBuilder

DEPRECATED: use getTrafficPolicy instead.

getProto() - Method in interface com.ngrok.Connection.Endpoint

Returns the protocol of this connection.

getProto() - Method in interface com.ngrok.ListenerInfo.Endpoint

Returns the protocol associated with this listener.

getProvider() - Method in class com.ngrok.Http.OAuth

Returns the OAuth provider.

getProvider() - Method in class com.ngrok.Http.WebhookVerification

Returns the provider for the webhook verification.

getProxyProto() - Method in class com.ngrok.EndpointBuilder

Returns the proxy protocol for this builder.

getProxyProtoVersion() - Method in class com.ngrok.EndpointBuilder

Returns the version of the proxy protocol for this endpoint.

getRemoteAddr() - Method in interface com.ngrok.Connection

Returns the remote address that established this connection.

getRemoteAddress() - Method in class com.ngrok.TcpBuilder

Returns the remote address on this builder.

getRemoteSocketAddress() - Method in class com.ngrok.jetty.NgrokEndpoint

getRemoveRequestHeaders() - Method in class com.ngrok.HttpBuilder

Returns the list of request headers to remove for this HTTP endpoint.

getRemoveResponseHeaders() - Method in class com.ngrok.HttpBuilder

Returns the list of response headers to remove for this HTTP endpoint.

getRequestHeaders() - Method in class com.ngrok.HttpBuilder

Returns the list of request headers to add for this HTTP endpoint.

getResponseHeaders() - Method in class com.ngrok.HttpBuilder

Returns the list of response headers to add for this HTTP endpoint.

getScheme() - Method in class com.ngrok.HttpBuilder

Returns the scheme for this HTTP endpoint.

getSchemeName() - Method in class com.ngrok.HttpBuilder

Returns the scheme name for this HTTP endpoint.

getScope() - Method in class com.ngrok.Http.OIDC

Returns the scope to be used by OIDC.

getScopes() - Method in class com.ngrok.Http.OAuth

Returns the scope to be used by OAuth.

getSecret() - Method in class com.ngrok.Http.WebhookVerification

Returns the secret for the webhook verification.

getServerAddr() - Method in class com.ngrok.Session.Builder

Returns the server address for this builder.

getTerminationCertPEM() - Method in class com.ngrok.TlsBuilder

Sets the certificate to use for TLS termination for this TLS endpoint.

getTerminationKeyPEM() - Method in class com.ngrok.TlsBuilder

Sets the key to use for TLS termination for this TLS endpoint.

getTrafficPolicy() - Method in class com.ngrok.EndpointBuilder

Returns the policy for this endpoint.

getTransport() - Method in class com.ngrok.jetty.NgrokConnector

Throws an UnsupportedOperationException, as the transport used by ngrok connector is not supported.

getTransport() - Method in class com.ngrok.jetty.NgrokEndpoint

Throws an UnsupportedOperationException, as the transport used by ngrok endpoints is not supported.

getType() - Method in class com.ngrok.Session.ClientInfo

Returns the type of this client.

getUrl() - Method in interface com.ngrok.ListenerInfo.Endpoint

Returns the URL at which this listener receives new connections.

getUsername() - Method in class com.ngrok.Http.BasicAuth

Returns the username for basic auth.

getValue() - Method in class com.ngrok.Http.Header

Returns the value of the header.

getVersion() - Method in class com.ngrok.Session.ClientInfo

Returns the version of this client.

getWebhookVerification() - Method in class com.ngrok.HttpBuilder

Returns the webhook verification options for this HTTP endpoint.

H

hasClientConfigured() - Method in class com.ngrok.Http.OAuth

Returns of client ID and secret have been configured for OAuth

Header(String, String) - Constructor for class com.ngrok.Http.Header

Constructs a new header with the specified name and value.

heartbeat(long) - Method in interface com.ngrok.Session.HeartbeatHandler

Called on each successful heartbeat, with the duration it took to execute it.

heartbeatHandler() - Method in class com.ngrok.Session.Builder

Returns the heartbeat handler for this builder.

heartbeatHandler(Session.HeartbeatHandler) - Method in class com.ngrok.Session.Builder

Sets the heartbeat handler for this builder

heartbeatInterval(Duration) - Method in class com.ngrok.Session.Builder

Sets the heartbeat interval for this builder

heartbeatTolerance(Duration) - Method in class com.ngrok.Session.Builder

Sets the heartbeat tolerance for this builder

Http - Interface in com.ngrok

A set of data classes to support creation of HTTP endpoint listeners.

HTTP - com.ngrok.Http.Scheme

Http.BasicAuth - Class in com.ngrok

Represents basic authentication options for an HTTP listener.

Http.Header - Class in com.ngrok

Represents an HTTP header.

Http.OAuth - Class in com.ngrok

Represents OAuth configuration for an HTTP listener.

Http.OIDC - Class in com.ngrok

Represents OIDC configuration for an HTTP listener.

Http.Scheme - Enum in com.ngrok

Represents the scheme for an HTTP listener.

Http.WebhookVerification - Class in com.ngrok

Represents webhook verification options for an HTTP listener.

HttpBuilder - Class in com.ngrok

A builder for creating a HTTP endpoint listener

HttpBuilder(Session) - Constructor for class com.ngrok.HttpBuilder

Creates a new HttpBuilder with a given session.

httpEndpoint() - Method in interface com.ngrok.Session

Creates a new HttpBuilder associated with this session.

HTTPS - com.ngrok.Http.Scheme

I

inetAddress() - Method in interface com.ngrok.Connection

Creates an InetSocketAddress for this connection's remote address.

isCompression() - Method in class com.ngrok.HttpBuilder

Returns whether compression is enabled for this HTTP endpoint.

isPassthroughTls() - Method in interface com.ngrok.Connection.Edge

Returns if this connection is passthrough TLS connection

isWebsocketTcpConversion() - Method in class com.ngrok.HttpBuilder

Returns whether WebSocket to TCP conversion is enabled for this HTTP endpoint.

J

join() - Method in interface com.ngrok.Forwarder

Waits for this forwarder to complete.

L

label(String, String) - Method in class com.ngrok.EdgeBuilder

Adds a label with the specified key and value to this builder.

listen() - Method in class com.ngrok.EdgeBuilder

listen() - Method in class com.ngrok.HttpBuilder

listen() - Method in interface com.ngrok.Listener.Builder

Starts listening and accepting new connections.

listen() - Method in class com.ngrok.TcpBuilder

listen() - Method in class com.ngrok.TlsBuilder

listen(int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.listen(int)

listenEdge(EdgeBuilder) - Method in interface com.ngrok.Session

Configures and starts a Listener.Edge

Listener<C extends Connection> - Interface in com.ngrok

Listener enables applications to handle incoming traffic proxied by ngrok.

Listener.Builder<L extends Listener> - Interface in com.ngrok

Represents a builder that can create new Listener instances.

Listener.Edge - Interface in com.ngrok

Represents an edge Listener.

Listener.Endpoint - Interface in com.ngrok

Represents an endpoint Listener.

ListenerInfo - Interface in com.ngrok

Represents information about a running Listener.

ListenerInfo.Edge - Interface in com.ngrok

Represents information about a running Listener.Edge.

ListenerInfo.Endpoint - Interface in com.ngrok

Represents information about a running Listener.Endpoint.

ListenerServerSocket - Class in com.ngrok.net

A server socket for accepting connections from a Listener.

ListenerServerSocket(Listener) - Constructor for class com.ngrok.net.ListenerServerSocket

Creates a new server socket for the given listener.

ListenerSocketImpl - Class in com.ngrok.net

An implementation of the AbstractSocketImpl interface for accepting connections on a Listener

ListenerSocketImpl(Listener) - Constructor for class com.ngrok.net.ListenerSocketImpl

Creates a new listener socket implementation for the given listener.

listenHttp(HttpBuilder) - Method in interface com.ngrok.Session

Configures and starts a HTTP Listener.Endpoint

listenTcp(TcpBuilder) - Method in interface com.ngrok.Session

Configures and starts a TCP Listener.Endpoint

listenTls(TlsBuilder) - Method in interface com.ngrok.Session

Configures and starts a TLS Listener.Endpoint

M

metadata(String) - Method in class com.ngrok.MetadataBuilder

Sets the metadata for this endpoint.

metadata(String) - Method in class com.ngrok.Session.Builder

Sets the metadata for this builder

MetadataBuilder<T extends MetadataBuilder> - Class in com.ngrok

An abstract builder sharing common attributes of all listener builders.

MetadataBuilder() - Constructor for class com.ngrok.MetadataBuilder

mutualTLSCA(byte[]) - Method in class com.ngrok.HttpBuilder

Sets the certificates to use for client authentication for this HTTP endpoint.

mutualTLSCA(byte[]) - Method in class com.ngrok.TlsBuilder

Sets the certificates to use for client authentication for this TLS endpoint.

N

name - Variable in enum com.ngrok.Http.Scheme

The name of the scheme.

needsFillInterest() - Method in class com.ngrok.jetty.NgrokEndpoint

Schedules the endpoint to be filled with interest.

NgrokConnector - Class in com.ngrok.jetty

A class representing a connector implementation for ngrok listeners.

NgrokConnector(Server, Supplier<Session>, Function<Session, Listener>) - Constructor for class com.ngrok.jetty.NgrokConnector

Constructs a new ngrok connector with the specified server, session supplier, and listener function.

NgrokEndpoint - Class in com.ngrok.jetty

A class representing an endpoint for ngrok connection.

NgrokEndpoint(Scheduler, Connection) - Constructor for class com.ngrok.jetty.NgrokEndpoint

Constructs a new ngrok endpoint with the specified scheduler and connection.

NgrokException - Exception in com.ngrok

NgrokException(String, String) - Constructor for exception com.ngrok.NgrokException

None - com.ngrok.ProxyProto

O

OAuth(String) - Constructor for class com.ngrok.Http.OAuth

Constructs new OAuth configuration with the specified provider.

oauthOptions(Http.OAuth) - Method in class com.ngrok.HttpBuilder

Sets OAuth for this HTTP endpoint.

OIDC(String, String, String) - Constructor for class com.ngrok.Http.OIDC

Constructs a new OIDC configuration with the specified issuer URL, client ID, and client secret.

oidcOptions(Http.OIDC) - Method in class com.ngrok.HttpBuilder

Sets OIDC for this HTTP endpoint.

onCommand() - Method in interface com.ngrok.Session.CommandHandler

Called when the associated event triggers.

onIncompleteFlush() - Method in class com.ngrok.jetty.NgrokEndpoint

Throws an UnsupportedOperationException, as incomplete flush is not supported by ngrok endpoints.

P

policy(String) - Method in class com.ngrok.EndpointBuilder

DEPRECATED: use trafficPolicy instead.

proxyProto(ProxyProto) - Method in class com.ngrok.EndpointBuilder

Sets the proxy protocol for this endpoint.

ProxyProto - Enum in com.ngrok

Enum representing the proxy protocol version.

R

read() - Method in class com.ngrok.net.ConnectionInputStream

Reads a single byte of data from the input stream.

read(byte[], int, int) - Method in class com.ngrok.net.ConnectionInputStream

Reads up to len bytes of data from the input stream into an array of bytes.

read(ByteBuffer) - Method in interface com.ngrok.Connection

Reads the next available bytes from this connection, up to the buffer capacity.

remoteAddress(String) - Method in class com.ngrok.TcpBuilder

Sets the TCP address to request for this TCP endpoint.

removeRequestHeader(String) - Method in class com.ngrok.HttpBuilder

Adds a header to the list of removed request headers for this HTTP endpoint.

removeResponseHeader(String) - Method in class com.ngrok.HttpBuilder

Adds a header to the list of removed response headers for this HTTP endpoint.

restartCallback() - Method in class com.ngrok.Session.Builder

Returns the restart callback handler for this builder.

restartCallback(Session.CommandHandler) - Method in class com.ngrok.Session.Builder

Sets the restart callback handler for this builder

S

scheme(Http.Scheme) - Method in class com.ngrok.HttpBuilder

Sets the scheme for this HTTP endpoint.

scope(String) - Method in class com.ngrok.Http.OAuth

Sets the scope for OAuth.

scope(String) - Method in class com.ngrok.Http.OIDC

Sets the scope to be used by OIDC.

sendUrgentData(int) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketImpl.sendUrgentData(int)

serverAddr(String) - Method in class com.ngrok.Session.Builder

Sets the server address for this builder

Session - Interface in com.ngrok

A session with the ngrok service.

Session.Builder - Class in com.ngrok

A builder for creating a session

Session.ClientInfo - Class in com.ngrok

Represents additional information about the client.

Session.CommandHandler - Interface in com.ngrok

Provides a way to listen for specific server side events.

Session.HeartbeatHandler - Interface in com.ngrok

Provides a way to monitor current session's heartbeats and disconnects.

setConnection(Connection) - Method in class com.ngrok.net.ConnectionSocketImpl

setOption(int, Object) - Method in class com.ngrok.net.AbstractSocketImpl

See SocketOptions.setOption(int, Object)

stopCallback() - Method in class com.ngrok.Session.Builder

Returns the stop callback handler for this builder.

stopCallback(Session.CommandHandler) - Method in class com.ngrok.Session.Builder

Sets the stop callback handler for this builder

T

TcpBuilder - Class in com.ngrok

A builder for creating a TCP endpoint listener

TcpBuilder(Session) - Constructor for class com.ngrok.TcpBuilder

Creates a new TcpBuilder with a given session.

tcpEndpoint() - Method in interface com.ngrok.Session

Creates a new TcpBuilder associated with this session.

termination(byte[], byte[]) - Method in class com.ngrok.TlsBuilder

Sets the certificate and key to use for TLS termination for this TLS endpoint.

timeout() - Method in interface com.ngrok.Session.HeartbeatHandler

Called when session times out (e.g.

TlsBuilder - Class in com.ngrok

A builder for creating a TLS endpoint listener

TlsBuilder(Session) - Constructor for class com.ngrok.TlsBuilder

Creates a new TlsBuilder with a given session.

tlsEndpoint() - Method in interface com.ngrok.Session

Creates a new TlsBuilder associated with this session.

trafficPolicy(String) - Method in class com.ngrok.EndpointBuilder

Sets the policy for this endpoint.

U

updateCallback() - Method in class com.ngrok.Session.Builder

Returns the update callback handler for this builder.

updateCallback(Session.CommandHandler) - Method in class com.ngrok.Session.Builder

Sets the update callback handler for this builder

V

V1 - com.ngrok.ProxyProto

V2 - com.ngrok.ProxyProto

valueOf(String) - Static method in enum com.ngrok.Http.Scheme

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.ngrok.ProxyProto

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.ngrok.Http.Scheme

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.ngrok.ProxyProto

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in enum com.ngrok.ProxyProto

The version of the proxy protocol.

version() - Method in enum com.ngrok.ProxyProto

Returns the version of the proxy protocol.

W

webhookVerification(Http.WebhookVerification) - Method in class com.ngrok.HttpBuilder

Sets webhook verification for this HTTP endpoint.

WebhookVerification(String, String) - Constructor for class com.ngrok.Http.WebhookVerification

Constructs a new set of webhook verification options with the specified provider and secret.

websocketTcpConversion() - Method in class com.ngrok.HttpBuilder

Enables Websocket to TCP conversion for this HTTP endpoint.

withAuthtoken(String) - Static method in interface com.ngrok.Session

Creates a new session Session.Builder with specified ngrok authtoken

withAuthtokenFromEnv() - Static method in interface com.ngrok.Session

Creates a new session Session.Builder resolving the ngrok authtoken from NGROK_AUTHTOKEN env variable

write(byte[], int, int) - Method in class com.ngrok.net.ConnectionOutputStream

Writes bytes from the specified byte array starting at offset off to the output stream.

write(int) - Method in class com.ngrok.net.ConnectionOutputStream

Writes a single byte of data to the output stream.

write(ByteBuffer) - Method in interface com.ngrok.Connection

Writes a sequence of bytes to this connection from the given buffer.

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages