caffix/service

// Copyright © by Jeff Foley 2020-2023. All rights reserved.
// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.
// SPDX-License-Identifier: Apache-2.0

package service

import "fmt"

// Service handles queued requests at an optional rate limit.
type Service interface {
    fmt.Stringer

    // Description returns a greeting message from the service.
    Description() string

    // Start requests that the service be started.
    Start() error

    // OnStart is called when the Start method requests the service be started.
    OnStart() error

    // Stop requests that the service be stopped.
    Stop() error

    // OnStop is called when the Stop method requests the service be stopped.
    OnStop() error

    // Done returns a channel that is closed when the service is stopped.
    Done() <-chan struct{}

    // Input returns a channel that the service receives requests on.
    Input() chan interface{}

    // HandlesReq returns true when the provided request is processed by the service.
    HandlesReq(req interface{}) bool

    // Output returns a channel that the service send results on.
    Output() chan interface{}

    // SetRateLimit sets the number of calls to the OnRequest method each second.
    SetRateLimit(persec int)

    // CheckRateLimit blocks until the minimum wait duration since the last call.
    CheckRateLimit()
}