The highest tagged major version is v3.

client

package

v1.20.4 Latest Latest Go to latest Published: May 13, 2019 License: MIT Imports: 20 Imported by: 6

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/Jeffail/benthos

Links

Open Source Insights

Documentation ¶

Index ¶

func OptSetCloseChan(c <-chan struct{}) func(*Type)
func OptSetHTTPTransport(transport *http.Transport) func(*Type)
func OptSetLogger(log log.Modular) func(*Type)
func OptSetManager(mgr types.Manager) func(*Type)
func OptSetStats(stats metrics.Type) func(*Type)
type Config
- func NewConfig() Config
type Type
- func New(conf Config, opts ...func(*Type)) (*Type, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func OptSetCloseChan ¶

func OptSetCloseChan(c <-chan struct{}) func(*Type)

OptSetCloseChan sets a channel that when closed will interrupt any blocking calls within the client.

func OptSetHTTPTransport ¶ added in v1.3.2

func OptSetHTTPTransport(transport *http.Transport) func(*Type)

OptSetHTTPTransport sets the HTTP Transport to use. NOTE: This setting will override any configured TLS options.

func OptSetLogger ¶ added in v0.16.2

func OptSetLogger(log log.Modular) func(*Type)

OptSetLogger sets the logger to use.

func OptSetManager ¶ added in v0.31.3

func OptSetManager(mgr types.Manager) func(*Type)

OptSetManager sets the manager to use.

func OptSetStats ¶ added in v0.16.2

func OptSetStats(stats metrics.Type) func(*Type)

OptSetStats sets the metrics aggregator to use.

Types ¶

type Config ¶

type Config struct {
	URL         string            `json:"url" yaml:"url"`
	Verb        string            `json:"verb" yaml:"verb"`
	Headers     map[string]string `json:"headers" yaml:"headers"`
	RateLimit   string            `json:"rate_limit" yaml:"rate_limit"`
	Timeout     string            `json:"timeout" yaml:"timeout"`
	Retry       string            `json:"retry_period" yaml:"retry_period"`
	MaxBackoff  string            `json:"max_retry_backoff" yaml:"max_retry_backoff"`
	NumRetries  int               `json:"retries" yaml:"retries"`
	BackoffOn   []int             `json:"backoff_on" yaml:"backoff_on"`
	DropOn      []int             `json:"drop_on" yaml:"drop_on"`
	TLS         tls.Config        `json:"tls" yaml:"tls"`
	auth.Config `json:",inline" yaml:",inline"`
}

Config is a configuration struct for an HTTP client.

func NewConfig ¶

func NewConfig() Config

NewConfig creates a new Config with default values.

type Type ¶

type Type struct {
	// contains filtered or unexported fields
}

Type is an output type that pushes messages to Type.

func New ¶

func New(conf Config, opts ...func(*Type)) (*Type, error)

New creates a new Type.

func (*Type) CreateRequest ¶ added in v0.16.0

func (h *Type) CreateRequest(msg types.Message) (req *http.Request, err error)

CreateRequest creates an HTTP request out of a single message.

func (*Type) Do ¶ added in v0.16.0

func (h *Type) Do(msg types.Message) (res *http.Response, err error)

Do attempts to create and perform an HTTP request from a message payload. This attempt may include retries, and if all retries fail an error is returned.

func (*Type) ParseResponse ¶ added in v0.16.0

func (h *Type) ParseResponse(res *http.Response) (resMsg types.Message, err error)

ParseResponse attempts to parse an HTTP response into a 2D slice of bytes.

func (*Type) Send ¶

func (h *Type) Send(msg types.Message) (types.Message, error)

Send attempts to send a message to an HTTP server, this attempt may include retries, and if all retries fail an error is returned. The message payload can be nil, in which case an empty body is sent. The response will be parsed back into a message, meaning mulitpart content handling is done for you.

If the response body is empty the message returned is nil.

Source Files ¶

View all Source files

type.go

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