library/org.xmtp.android.library/LimitsConfiguration

LimitsConfiguration

data class LimitsConfiguration(val maxEnvelopeBytes: Long, val maxRequestBytes: Long, val maxResponseBytes: Long, val maxPublishTopics: Long, val maxQueryTopics: Long, val maxQueryLimit: Long, val defaultQueryLimit: Long, val maxNewestMetadataTopics: Long, val maxNewestFullTopics: Long, val maxUpdateAdds: Long, val maxUpdateRemoves: Long, val maxStreamTopics: Long, val maxStaticTopics: Long, val maxLookupIdentifiers: Long, val maxScwSignatures: Long, val maxIdentityEntries: Long, val maxUpdateFramesPerSecond: UInt, val maxUpdateBurst: UInt, val maxPingFramesPerSecond: UInt, val maxPingBurst: UInt)

Request shapes the deployment accepts. The client chunks its own work to these values; an app reads them to size its batches.

Constructors

LimitsConfiguration

constructor(maxEnvelopeBytes: Long, maxRequestBytes: Long, maxResponseBytes: Long, maxPublishTopics: Long, maxQueryTopics: Long, maxQueryLimit: Long, defaultQueryLimit: Long, maxNewestMetadataTopics: Long, maxNewestFullTopics: Long, maxUpdateAdds: Long, maxUpdateRemoves: Long, maxStreamTopics: Long, maxStaticTopics: Long, maxLookupIdentifiers: Long, maxScwSignatures: Long, maxIdentityEntries: Long, maxUpdateFramesPerSecond: UInt, maxUpdateBurst: UInt, maxPingFramesPerSecond: UInt, maxPingBurst: UInt)

Properties

defaultQueryLimit

val defaultQueryLimit: Long

maxEnvelopeBytes

val maxEnvelopeBytes: Long

maxIdentityEntries

val maxIdentityEntries: Long

maxLookupIdentifiers

val maxLookupIdentifiers: Long

maxNewestFullTopics

val maxNewestFullTopics: Long

maxNewestMetadataTopics

val maxNewestMetadataTopics: Long

maxPingBurst

val maxPingBurst: UInt

maxPingFramesPerSecond

val maxPingFramesPerSecond: UInt

maxPublishTopics

val maxPublishTopics: Long

maxQueryLimit

val maxQueryLimit: Long

maxQueryTopics

val maxQueryTopics: Long

maxRequestBytes

val maxRequestBytes: Long

maxResponseBytes

val maxResponseBytes: Long

maxScwSignatures

val maxScwSignatures: Long

maxStaticTopics

val maxStaticTopics: Long

maxStreamTopics

val maxStreamTopics: Long

maxUpdateAdds

val maxUpdateAdds: Long

maxUpdateBurst

val maxUpdateBurst: UInt

maxUpdateFramesPerSecond

val maxUpdateFramesPerSecond: UInt

The four rates the wire publishes as uint32 stay unsigned, because a deployment may publish any value a uint32 holds and a signed Int would have to reject the top half of that range.

maxUpdateRemoves

val maxUpdateRemoves: Long