<<

NAME

Kernel::GenericInterface::ErrorHandling::RequestRetry - Module do decide about rescheduling for failed requests

SYNOPSIS

PUBLIC INTERFACE

new()

create an object. Do not create it directly, instead use:

    use Kernel::System::ObjectManager;
    local $Kernel::OM = Kernel::System::ObjectManager->new();
    my $ErrorObject = $Kernel::OM->Get('Kernel::GenericInterface::ErrorHandling');
Run()

Decides if a non-successful request should be retried, based on the configuration. Relevant module configuration variables are: - ScheduleRetry # enable or disable retry for request - RetryIntervalStart # time in seconds for first retry after initial request - RetryIntervalFactor # send further retries after the same interval as the first or in increasing intervals - RetryIntervalMax # maximum allowed interval between retries - RetryCountMax # maximum allowed number of retries - RetryPeriodMax # maximum time allowed for retries after initial request

    my $Result = $ErrorObject->Run(
        PastExecutionData => $PastExecutionDataStructure,   # optional
        ModuleConfig      => $ModuleConfig,
    );

    $Result = {
        Success       => 1,          # 0 or 1
        ErrorMessage  => '',         # if an error occurred
        Data          => { ... },    # result payload
        ReScheduleData => { ... },   # reschedule information
    };

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.

<<