client

package

v1.10.2 Latest Latest Go to latest Published: Jun 9, 2022 License: LGPL-3.0 Imports: 15 Imported by: 1

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

This section is empty.

View Source

var (
	ErrEmptyServerURL   = errors.New("empty contentserver url provided")
	ErrInvalidServerURL = errors.New("invalid contentserver url provided")
)

func NewHTTPTransport(server string, client *http.Client) transport

NewHTTPTransport will create a new http transport for the given server and client. Caution: the provided server url is not validated!

func NewSocketTransport(server string, connectionPoolSize int, waitTimeout time.Duration) transport

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

Client a content server client

func NewClient(
	server string,
	connectionPoolSize int,
	waitTimeout time.Duration,
) (c *Client, err error)

func NewClientWithTransport(
	transport transport,
) (c *Client, err error)

func NewHTTPClient(server string) (c *Client, err error)

NewHTTPClient constructs a new client to talk to the contentserver. It returns an error if the provided url is empty or invalid.

func NewHTTPClientWithTransport(transport transport) (c *Client, err error)

func (c *Client) GetContent(request *requests.Content) (*content.SiteContent, error)

GetContent request site content

func (c *Client) GetNodes(env *requests.Env, nodes map[string]*requests.Node) (map[string]*content.Node, error)

GetNodes request nodes

func (c *Client) GetRepo() (map[string]*content.RepoNode, error)

GetRepo get the whole repo

func (c *Client) GetURIs(dimension string, IDs []string) (map[string]string, error)

GetURIs resolve uris for ids in a dimension

func (c *Client) ShutDown()

func (c *Client) Update() (*responses.Update, error)

Update tell the server to update itself