zcash-android-wallet-sdk/docs/-twig

zcash-android-wallet-sdk / cash.z.wallet.sdk.data / Twig

Twig

interface Twig

A tiny log.

Functions

Name	Summary
plus	open operator fun plus(twig: Twig): Twig
twig	abstract fun twig(logMessage: String= ""):Unit

Companion Object Functions

Name	Summary
clip	fun clip(leaf: Leaf): Boolean Clip a leaf from the bush. Clipped leaves no longer appear in logs.
plant	fun plant(rootTwig: Twig): Unit Plants the twig, making it the one and only bush. Twigs can be bundled together to create the appearance of multiple bushes (i.e Twig.plant(twigA + twigB + twigC)) even though there's only ever one bush.
sprout	fun sprout(leaf: Leaf): Boolean Generate a leaf on the bush. Leaves show up in every log message as tags until they are clipped.

Extension Functions

Name	Summary
twigTask	fun <R> Twig.twigTask(logMessage: String, block: () -> R): R A tiny log task. Execute the block of code with some twigging around the outside. For silent twigs, this adds a small amount of overhead at the call site but still avoids logging.

Inheritors

Name	Summary
ActiveTransactionManager	class ActiveTransactionManager : CoroutineScope, Twig Manages active send/receive transactions. These are transactions that have been initiated but not completed with sufficient confirmations. All other transactions are stored in a separate TransactionRepository.
CompactBlockProcessor	class CompactBlockProcessor : Twig Responsible for processing the blocks on the stream. Saves them to the cacheDb and periodically scans for transactions.
CompactBlockStream	class CompactBlockStream : Twig Serves as a source of compact blocks received from the light wallet server. Once started, it will request all the appropriate blocks and then stream them into the channel returned when calling start.
CompositeTwig	open class CompositeTwig : Twig Since there can only ever be one trunk on the bush of twigs, this class lets you cheat and make that trunk be a bundle of twigs.
SilentTwig	class SilentTwig : Twig A tiny log that does nothing. No one hears this twig fall in the woods.
TroubleshootingTwig	open class TroubleshootingTwig : Twig A tiny log for detecting troubles. Aim at your troubles and pull the twigger.