ksrpc-server/com.monkopedia.ksrpc.server/BaseServiceApp

BaseServiceApp

abstract class BaseServiceApp : CliktCommand

Base class that makes it easy to host a default service on any combination of std in/out, http, and sockets.

Inheritors

ServiceApp

Types

Companion

object Companion

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

appName

val appName: String

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

commandName

val commandName: String

cors

val cors: Boolean

currentContext

val currentContext: Context

env

open val env: KsrpcEnvironment<String>

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open val hiddenFromHelp: Boolean

http

val http: List<Int>

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

stdOut

val stdOut: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

aliases

open fun aliases(): Map<String, List<String>>

allHelpParams

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

commandHelp

open fun ~~commandHelp~~(context: Context): String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context: Context): String

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

configureHttp

open fun Application.configureHttp()

createChannel

abstract fun createChannel(): SerializedService<String>

echo

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

embeddedServer

abstract fun embeddedServer(port: Int, function: Application.() -> Unit): EmbeddedServer<*, *>

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

issueMessage

fun issueMessage(message: String)

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CoreCliktCommand>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

resetContext

fun resetContext(parent: Context?): Context

run

open override fun run()

toString

open override fun toString(): String