HttpContext.h

Go to the documentation of this file.

// ============================================================================
// Copyright 2017-2024, Schlumberger
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ============================================================================

#pragma once

#include <cstdint>
#include <string>

namespace seismicdrive
{
    /*******************************************************************************/ 
    enum class HttpConnectionLink
    {
        ANY,
        SEISMIC_DMS,
        CLOUD_STORAGE
    };

    /*******************************************************************************/ 
    struct ExponentialRetryBackoffPolicy
    {

        bool enabled{true};
        uint64_t maxRetry{10};
        uint64_t maxWaitingTimeMicroSec{32000000};
        uint64_t initialWaitingTimeMicroSec{500000};
    };

    /*******************************************************************************/ 
    struct HttpContext
    {

        // The maximum time in seconds the access request is supposed to take. Abort access if it takes more than ${timeoutSecs} seconds.
        // Default value set according to the default timeouts applied to seismic-dms service // max waiting time before aborting the request
        uint32_t timeoutSecs{300};

        // Abort the transfer if the transfer speed is slower than ${lowSpeedLimitBytesPerSec} bytes per second for a duration of ${lowSpeedTimeSecs} seconds.
        // This option is disabled by default (0 value applied).
        // Do not change these values as the slowness detection is not required on the seismic-dms connection link (request to seismic store service)
        // It has been demonstrated to be a source of non-controllable retries, It should be tuned correctly, but in this case the ${timeoutSec} is already an acceptable value.
        // The connection is wanted to be hung for more than ${timeoutSec}
        uint32_t lowSpeedLimitBytesPerSec{0};
        uint32_t lowSpeedTimeSecs{0};

        // # NOTE OF DEPRECATION #
        // This comment is to delete after the GCSAccessor have been removed from the exported interface of sdapi.
        // If a client application sets its own context on gcs link only (usage of SDAPI as GCS SDK), consider this setting:
        // lowSpeedLimitBytesPerSec = 30 AND lowSpeedTimeSecs = 15

        // Enable re-authorization of credentials on Timeout due to either Access request or low speed limit options.
        bool reauthorizeOnTimeout{true};
        // Enable TCP Keep Alive probing.
        bool tcpKeepAlive{true};
        // Waiting time duration in seconds while the TCP connection is idle before sending Keep-Alive probes.
        uint32_t tcpKeepIdle{60};
        // Time interval in seconds between sending Keep-Alive probes.
        uint32_t tcpKeepIntvl{60};
    };

}