api

package module

v0.0.0-...-0159803 Latest Latest Go to latest Published: Feb 12, 2023 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dcaf-labs/solana-go-retryable-http-client

Links

Open Source Insights

README ¶

Go Retryable HTTPClient

This module is a wrapper around github.com/hashicorp/go-retryablehttp

This module provides two key features:

rate limit support
implements the HTTPClient interface in gagliardetto/solana-go

Getting Started

go get github.com/dcaf-labs/solana-go-retryable-http-client

Usage

examples/solanago will show an example useage with thegagliardetto/solana-go lib.

Documentation ¶

Index ¶

func DecodeRequestBody[V any](resp *http.Response, res V) (V, error)
func GetDefaultCheckRetry(_ context.Context, resp *http.Response, err error) (bool, error)
type RateLimitHTTPClientOptions
- func GetDefaultRateLimitHTTPClientOptions() RateLimitHTTPClientOptions
type RetryableHTTPClient
- func GetDefaultRateLimitedHTTPClient(options RateLimitHTTPClientOptions) RetryableHTTPClient
- func (r RetryableHTTPClient) CloseIdleConnections()
- func (r RetryableHTTPClient) Do(request *http.Request) (*http.Response, error)
type RetryableHTTPClientProvider
- func GetDefaultClientProvider() RetryableHTTPClientProvider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DecodeRequestBody ¶

func DecodeRequestBody[V any](resp *http.Response, res V) (V, error)

func GetDefaultCheckRetry ¶

func GetDefaultCheckRetry(_ context.Context, resp *http.Response, err error) (bool, error)

Types ¶

type RateLimitHTTPClientOptions ¶

type RateLimitHTTPClientOptions struct {
	CallsPerSecond   float64
	HttpClient       http.Client
	MaxRetries       int
	MinRetryDuration time.Duration
	CheckRetry       retryablehttp.CheckRetry
}

func GetDefaultRateLimitHTTPClientOptions ¶

func GetDefaultRateLimitHTTPClientOptions() RateLimitHTTPClientOptions

type RetryableHTTPClient ¶

type RetryableHTTPClient struct {
	*retryablehttp.Client
}

func GetDefaultRateLimitedHTTPClient ¶

func GetDefaultRateLimitedHTTPClient(options RateLimitHTTPClientOptions) RetryableHTTPClient

func (RetryableHTTPClient) CloseIdleConnections ¶

func (r RetryableHTTPClient) CloseIdleConnections()

func (RetryableHTTPClient) Do ¶

func (r RetryableHTTPClient) Do(request *http.Request) (*http.Response, error)

type RetryableHTTPClientProvider ¶

type RetryableHTTPClientProvider func(options RateLimitHTTPClientOptions) RetryableHTTPClient

func GetDefaultClientProvider ¶

func GetDefaultClientProvider() RetryableHTTPClientProvider

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL