restapi

Documentation

Overview

Package restapi implements an IPFS Cluster API component. It provides a REST-ish API to interact with Cluster over HTTP.

Index

• Variables
• type RESTAPI
  • func NewRESTAPI(apiMAddr ma.Multiaddr) (*RESTAPI, error)
  • func (rest *RESTAPI) SetClient(c *rpc.Client)
  • func (rest *RESTAPI) Shutdown() error

Variables

var (
	// maximum duration before timing out read of the request
	RESTAPIServerReadTimeout = 5 * time.Second
	// maximum duration before timing out write of the response
	RESTAPIServerWriteTimeout = 10 * time.Second
	// server-side the amount of time a Keep-Alive connection will be
	// kept idle before being reused
	RESTAPIServerIdleTimeout = 60 * time.Second
)

Server settings

Types

type RESTAPI

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

RESTAPI implements an API and aims to provides a RESTful HTTP API for Cluster.

func NewRESTAPI

func NewRESTAPI(apiMAddr ma.Multiaddr) (*RESTAPI, error)

NewRESTAPI creates a new REST API component. It receives the multiaddress on which the API listens.

func (*RESTAPI) SetClient

func (rest *RESTAPI) SetClient(c *rpc.Client)

SetClient makes the component ready to perform RPC requests.

func (*RESTAPI) Shutdown

func (rest *RESTAPI) Shutdown() error

Shutdown stops any API listeners.