porthole/live.gravitylabs.porthole/Porthole

Porthole

The debug-build entry point.

Installed automatically by PortholeInitializer on process start, so in the normal case the only things you call yourself are the register functions: they are what turn anonymous state objects into names an agent can reason about.

Everything here is a no-op in release builds, where the porthole-noop artifact with the same signatures takes its place.

Properties

DEFAULT_PORT

const val DEFAULT_PORT: Int = 8677

The port used when nothing says otherwise.

ENABLED

const val ENABLED: Boolean = true

True in debug builds where the real runtime is on the classpath.

Functions

attachComposeView

@JvmStatic

fun attachComposeView(view: View)

Makes a Compose view's semantics tree readable by the semantics_tree tool.

detachComposeView

@JvmStatic

fun detachComposeView(view: View)

Undoes attachComposeView. Call it when the view goes away.

install

@JvmStatic

@JvmOverloads

fun install(app: Application, port: Int = portFromResources(app))

Starts the porthole: collectors, and the socket the timeline and the MCP server connect to.

mark

@JvmStatic

@JvmOverloads

fun mark(label: String, detail: String? = null)

Marks a moment on the timeline.

nameState

@JvmStatic

fun nameState(state: Any, name: String)

Give a androidx.compose.runtime.State a readable name.

registerNavController

@JvmStatic

fun registerNavController(controller: Any)

Tracks a NavController's back stack, arguments and deep link.

registerViewModel

@JvmStatic

fun registerViewModel(name: String, viewModel: Any)

Names the state held by a ViewModel (or any object) so recomposition reports say CartViewModel.items instead of <unnamed:...>.

reportBackStack

@JvmStatic

fun reportBackStack(routes: List<String>)

Reports a back stack the app owns itself, rather than one androidx holds.

shutdown

@JvmStatic

fun shutdown()

Stops everything and closes the socket.