Skip to main content

//clika-runtime/io.clika.modelverse/ServeOptions

ServeOptions

[common]
data class ServeOptions(val host: String = "127.0.0.1", val port: Int = 8000, val modelId: String = "", val maxActive: Int = 4, val maxQueued: Int = 256, val defaultBudget: Int = 256, val enableWebUi: Boolean = true, val enableCors: Boolean = false, val logRequestTiming: Boolean = false, val maxUploadBytes: Long = 0, val readTimeoutSeconds: Int = 0)

The server's knobs (Modelverse.serve): the bind address, the advertised model id (the family when empty), the engine's width (requests decoding at once), its queue and its default decode budget, the web page, CORS, the request timing log, and the upload and read limits (0 keeps the library's).

Constructors​

ServeOptions[common]
constructor(host: String = "127.0.0.1", port: Int = 8000, modelId: String = "", maxActive: Int = 4, maxQueued: Int = 256, defaultBudget: Int = 256, enableWebUi: Boolean = true, enableCors: Boolean = false, logRequestTiming: Boolean = false, maxUploadBytes: Long = 0, readTimeoutSeconds: Int = 0)

Properties​

NameSummary
defaultBudget[common]
val defaultBudget: Int = 256
enableCors[common]
val enableCors: Boolean = false
enableWebUi[common]
val enableWebUi: Boolean = true
host[common]
val host: String
logRequestTiming[common]
val logRequestTiming: Boolean = false
maxActive[common]
val maxActive: Int = 4
maxQueued[common]
val maxQueued: Int = 256
maxUploadBytes[common]
val maxUploadBytes: Long = 0
modelId[common]
val modelId: String
port[common]
val port: Int = 8000
The port to bind; 0 picks a free one (Server.port reads it back).
readTimeoutSeconds[common]
val readTimeoutSeconds: Int = 0