Postbox

Postbox is the storage mechanism for requests that are to be processed asynchronously.

Types

data class PendingRequest(val requestId: RequestId, val request: Request, val processingTime: Instant, val failures: Int)

Atomically claim a batch of due requests for processing, marking them as RequestProcessingStatus.Processing until either they are finalised via markProcessed, markFailed or markDead, or until the given lease expires (after which they can be reclaimed by a subsequent call).

abstract fun markDead(requestId: RequestId, response: Response? = null): Result<Unit, PostboxError>

Mark a request as permanently failed (dead) with an optional response.

abstract fun markFailed(requestId: RequestId, delayReprocessing: Duration, response: Response?): Result<Unit, PostboxError>

Mark a request as failed with the given delay for reprocessing and an optional response.

abstract fun markProcessed(requestId: RequestId, response: Response): Result<Unit, PostboxError>

Mark a request as processed with the given response.

Retrieve all pending requests. Those are the ones that have not been claimed for processing, marked as processed or marked as dead yet.

Retrieve the status of a request.

Store a request in the Postbox for later processing.