ksrpc-server/com.monkopedia.ksrpc.server/ServiceApp

ServiceApp

expect abstract class ServiceApp(val appName: String) : BaseServiceApp

actual abstract class ServiceApp(val appName: String) : BaseServiceApp

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

actual abstract class ServiceApp(val appName: String) : BaseServiceApp

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

Constructors

expect constructor(appName: String)

actual constructor(appName: String)

actual constructor(appName: String)

Properties

val appName: String

val appName: String

val appName: String

commandHelp

open val ~~commandHelp~~: String

open val ~~commandHelp~~: String

open val ~~commandHelp~~: String

commandHelpEpilog

open val ~~commandHelpEpilog~~: String

open val ~~commandHelpEpilog~~: String

open val ~~commandHelpEpilog~~: String

commandName

val commandName: String

val commandName: String

val commandName: String

val cors: Boolean

val cors: Boolean

val cors: Boolean

currentContext

val currentContext: Context

val currentContext: Context

val currentContext: Context

enableWebsockets

val enableWebsockets: Boolean

open val env: KsrpcEnvironment<String>

open val env: KsrpcEnvironment<String>

open val env: KsrpcEnvironment<String>

helpTags

val helpTags: Map<String, String>

val helpTags: Map<String, String>

val helpTags: Map<String, String>

val http: List<Int>

val http: List<Int>

val http: List<Int>

invokeWithoutSubcommand

val invokeWithoutSubcommand: Boolean

val invokeWithoutSubcommand: Boolean

val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

val messages: List<String>

val messages: List<String>

val noHttp: Boolean

val port: List<Int>

printHelpOnEmptyArgs

val printHelpOnEmptyArgs: Boolean

val printHelpOnEmptyArgs: Boolean

val printHelpOnEmptyArgs: Boolean

val stdOut: Boolean

val stdOut: Boolean

val stdOut: Boolean

Functions

aliases

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

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

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

allHelpParams

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

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

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

commandHelp

open fun commandHelp(context: Context): String

open fun commandHelp(context: Context): String

open fun commandHelp(context: Context): String

commandHelpEpilog

open fun commandHelpEpilog(context: Context): String

open fun commandHelpEpilog(context: Context): String

open fun commandHelpEpilog(context: Context): String

open fun Application.configureHttp()

open fun Application.configureHttp()

open fun Application.configureHttp()

confirm

fun ~~confirm~~(text: String, default: Boolean?, uppercaseDefault: Boolean, showChoices: Boolean, choiceStrings: List<String>, promptSuffix: String, invalidChoiceMessage: String): Boolean?

fun ~~confirm~~(text: String, default: Boolean?, uppercaseDefault: Boolean, showChoices: Boolean, choiceStrings: List<String>, promptSuffix: String, invalidChoiceMessage: String): Boolean?

fun ~~confirm~~(text: String, default: Boolean?, uppercaseDefault: Boolean, showChoices: Boolean, choiceStrings: List<String>, promptSuffix: String, invalidChoiceMessage: String): Boolean?

abstract fun createChannel(): SerializedService<String>

abstract fun createChannel(): SerializedService<String>

abstract fun createChannel(): SerializedService<String>

echo

fun echo()

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

fun echo()

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

fun echo()

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

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

fun echoFormattedHelp(error: CliktError?)

fun echoFormattedHelp(error: CliktError?)

abstract fun embeddedServer(port: Int, function: Application.() -> Unit): BaseApplicationEngine

open override fun embeddedServer(port: Int, function: Application.() -> Unit): BaseApplicationEngine

open override fun embeddedServer(port: Int, function: Application.() -> Unit): BaseApplicationEngine

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

fun getFormattedHelp(error: CliktError?): String?

fun getFormattedHelp(error: CliktError?): String?

issueMessage

fun issueMessage(message: String)

fun issueMessage(message: String)

fun issueMessage(message: String)

main

fun main(argv: Array<out String>)

fun main(argv: List<String>)

fun main(argv: Array<out String>)

fun main(argv: List<String>)

fun main(argv: Array<out String>)

fun main(argv: List<String>)

parse

fun parse(argv: Array<String>, parentContext: Context?)

fun parse(argv: List<String>, parentContext: Context?)

fun parse(argv: Array<String>, parentContext: Context?)

fun parse(argv: List<String>, parentContext: Context?)

fun parse(argv: Array<String>, parentContext: Context?)

fun parse(argv: List<String>, parentContext: Context?)

prompt

fun ~~prompt~~(text: String, default: String?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<String>, promptSuffix: String, invalidChoiceMessage: String): String?

fun <T> ~~prompt~~(text: String, default: T?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<T>, promptSuffix: String, invalidChoiceMessage: String, convert: (String) -> ConversionResult<T>): T?

fun ~~prompt~~(text: String, default: String?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<String>, promptSuffix: String, invalidChoiceMessage: String): String?

fun <T> ~~prompt~~(text: String, default: T?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<T>, promptSuffix: String, invalidChoiceMessage: String, convert: (String) -> ConversionResult<T>): T?

fun ~~prompt~~(text: String, default: String?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<String>, promptSuffix: String, invalidChoiceMessage: String): String?

fun <T> ~~prompt~~(text: String, default: T?, showDefault: Boolean, showChoices: Boolean, hideInput: Boolean, choices: Collection<T>, promptSuffix: String, invalidChoiceMessage: String, convert: (String) -> ConversionResult<T>): T?

registerArgument

fun registerArgument(argument: Argument)

fun registerArgument(argument: Argument)

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

fun registeredArguments(): List<Argument>

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

fun registeredOptions(): List<Option>

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

fun registeredParameterGroups(): List<ParameterGroup>

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

fun registeredSubcommandNames(): List<String>

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CliktCommand>

fun registeredSubcommands(): List<CliktCommand>

fun registeredSubcommands(): List<CliktCommand>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

fun registerOptionGroup(group: ParameterGroup)

fun registerOptionGroup(group: ParameterGroup)

open override fun run()

open override fun run()

open override fun run()

toString

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String