client

Documentation

Overview

Implements an API client for the nginx API (https://github.com/mutablelogic/go-server/pkg/handler/nginx)

Index

• type Client
  • func New(endPoint string, opts ...client.ClientOpt) (*Client, error)
  • func (c *Client) Health() (string, time.Duration, error)
  • func (c *Client) Reload() error
  • func (c *Client) Reopen() error
  • func (c *Client) Test() error

Types

type Client

type Client struct {
	*client.Client
}

func New

func New(endPoint string, opts ...client.ClientOpt) (*Client, error)

Create a new API client, providing the endpoint (ie, http://example.com/api/nginx)

func (*Client) Health

func (c *Client) Health() (string, time.Duration, error)

Return health of the API - nginx version, uptime

func (*Client) Reload

func (c *Client) Reload() error

Reload the nginx configuration

func (*Client) Reopen

func (c *Client) Reopen() error

Reopen the log files (after rotation)

func (*Client) Test

func (c *Client) Test() error

Test the configuration