runtime-core/io.matthewnelson.kmp.tor.runtime.core.ctrl.builder/BuilderScopeClientAuthAdd

BuilderScopeClientAuthAdd

class BuilderScopeClientAuthAdd(source)

A DSL builder scope for configuring TorCmd.OnionClientAuth.Add.

All elements of this builder scope are optional, and not required.

Types

Link copied to clipboard
class FlagsBuilder

Configure flags for the TorCmd.OnionClientAuth.Add object, as described in control-spec#ONION_CLIENT_AUTH_ADD.

Functions

Link copied to clipboard
fun clientName(nickname: String?): BuilderScopeClientAuthAdd

Specify the nickname for this client key.

Link copied to clipboard
fun destroyKeyOnJobCompletion(destroy: Boolean): BuilderScopeClientAuthAdd

When true, an EnqueuedJob.invokeOnCompletion handler is automatically set when the resulting TorCmd.OnionClientAuth.Add object is enqueued. The handler calls AuthKey.Private.destroy upon job completion (either successfully or by cancellation/error).

Link copied to clipboard