netrrf

Documentation

Overview

Copyright (c) 2021 Mark Hindess

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type AuthenticationError
  • func (err AuthenticationError) Error() string
• type Client
  • func NewClient(host, password string) *Client
  • func (c *Client) Authenticate(ctx context.Context) error
  • func (c *Client) Config(ctx context.Context) (*types.ConfigResponse, error)
  • func (c *Client) FullStatus(ctx context.Context) (*types.StatusResponse, error)
  • func (c *Client) Request(ctx context.Context, uri string, res interface{}) error
  • func (c *Client) Status(ctx context.Context, t int) (*types.StatusResponse, error)
  • func (c *Client) WithHTTPClient(client HttpClient) *Client
  • func (c *Client) WithTimeout(t time.Duration) *Client
• type HttpClient

Types

type AuthenticationError

type AuthenticationError types.AuthResponse

func (AuthenticationError) Error

func (err AuthenticationError) Error() string

type Client

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

func NewClient

func NewClient(host, password string) *Client

func (*Client) Authenticate

func (c *Client) Authenticate(ctx context.Context) error

func (*Client) Config

func (c *Client) Config(ctx context.Context) (*types.ConfigResponse, error)

func (*Client) FullStatus

func (c *Client) FullStatus(ctx context.Context) (*types.StatusResponse, error)

func (*Client) Request

func (c *Client) Request(ctx context.Context, uri string, res interface{}) error

func (*Client) Status

func (c *Client) Status(ctx context.Context, t int) (*types.StatusResponse, error)

func (*Client) WithHTTPClient

func (c *Client) WithHTTPClient(client HttpClient) *Client

func (*Client) WithTimeout

func (c *Client) WithTimeout(t time.Duration) *Client

type HttpClient

type HttpClient interface {
	Do(req *http.Request) (*http.Response, error)
}