Reporter

data class Reporter(var url: String = "https://example.com/api/post/{streamId}/{sessionId}", var interval: Long = 1000, var cachedTransport: Boolean = true, var maxFileCacheSize: Long, var sessionId: UUID = UUID(0, 0), var connectTimeout: Int = 500, var readTimeout: Int = 500, var compress: Boolean = false, var apiKeyName: String = "graboxy-api-key", var apiKeyValue: String = "api-key-value")

The configuration for the reporter task serializing and sending the collected data through the transport.

Constructors

Link copied to clipboard
constructor(url: String = "https://example.com/api/post/{streamId}/{sessionId}", interval: Long = 1000, cachedTransport: Boolean = true, maxFileCacheSize: Long, sessionId: UUID = UUID(0, 0), connectTimeout: Int = 500, readTimeout: Int = 500, compress: Boolean = false, apiKeyName: String = "graboxy-api-key", apiKeyValue: String = "api-key-value")

Properties

Link copied to clipboard

Name of the api key sent in the HTTP header

Link copied to clipboard

Value of the api key sent in the HTTP header

Link copied to clipboard

Whether to cache data packets on the device when connection to the remote server cannot be established.

Link copied to clipboard

Whether to compress the data sent to the server. If true GZIP compression is used.

Link copied to clipboard

The connect timeout for the HTTP transport in milliseconds.

Link copied to clipboard

The time interval the reporter task runs with.

Link copied to clipboard

About how much space on the device can be used to store unsent data packets.

Link copied to clipboard

The read timeout for the HTTP transport in milliseconds.

Link copied to clipboard

The persistent session id to send in the header frame. Must be set manually with a custom config class!

Link copied to clipboard
var url: String

The URL to send the data packets to.