<?php

namespace PrestaShop\CircuitBreaker\Contract;

use DateTime;

/**
 * Once the circuit breaker call a service,
 * a transaction is initialized and stored.
 */
interface TransactionInterface
{
    /**
     * @return string the service name
     */
    public function getService();

    /**
     * @return int the number of failures to call the service
     */
    public function getFailures();

    /**
     * @return string the current state of the Circuit Breaker
     */
    public function getState();

    /**
     * @return DateTime the time when the circuit breaker move
     *                  from open to half open state
     */
    public function getThresholdDateTime();

    /**
     * Everytime the service call fails, increment the number of failures.
     *
     * @return bool
     */
    public function incrementFailures();
}