client

Documentation

Index

• Constants
• type HTTPclient
  • func New(host string) (*HTTPclient, error)
  • func (c *HTTPclient) Request(method string, jsonBody any, params []string, urlPath ...string) ([]byte, int, error)
  • func (c *HTTPclient) SetHostAddr(host *url.URL) error
  • func (c *HTTPclient) SetRetries(n int)
  • func (c *HTTPclient) SetTimeout(d time.Duration)

Constants

const (
	// HTTPGET is the method string used for calling Request()
	HTTPGET = http.MethodGet
	// HTTPPOST is the method string used for calling Request()
	HTTPPOST = http.MethodPost
	// HTTPDELETE is the method string used for calling
	HTTPDELETE = http.MethodDelete

	// DefaultRetries this enables Request() to handle the situation where the server connection fails
	DefaultRetries = 3
	// DefaultTimeout is the default timeout for the HTTP client
	DefaultTimeout = 10 * time.Second
)

Types

type HTTPclient

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

HTTPclient is the Vocdoni API HTTP client.

func New

func New(host string) (*HTTPclient, error)

New connects to the API host with a random bearer token and returns the handle

func (*HTTPclient) Request

func (c *HTTPclient) Request(method string, jsonBody any, params []string, urlPath ...string) ([]byte, int, error)

Request performs a `method` type raw request to the endpoint specified in urlPath parameter. Method is either GET or POST. If POST, a JSON struct should be attached. Returns the response, the status code and an error.

Supports query parameters via `params` slice. If the slice is not empty, it should contain pairs of strings; the first element of each pair is the key, and the second element is the value.

func (*HTTPclient) SetHostAddr

func (c *HTTPclient) SetHostAddr(host *url.URL) error

SetHostAddr configures the host address of the API server.

func (*HTTPclient) SetRetries

func (c *HTTPclient) SetRetries(n int)

SetRetries configures the number of retries for the HTTP client.

func (*HTTPclient) SetTimeout

func (c *HTTPclient) SetTimeout(d time.Duration)

SetTimeout configures the timeout for the HTTP client.