inet

Documentation

Overview

Package inet implements the Connector interface using an HTTP REST API.

Index

• Variables
• func SendFleetAPICommand(ctx context.Context, client *http.Client, userAgent, authHeader string, ...) ([]byte, error)
• type Connection
  • func NewConnection(vin string, authHeader, serverURL, userAgent string) *Connection
  • func (c *Connection) Close()
  • func (c *Connection) PreferredAuthMethod() connector.AuthMethod
  • func (c *Connection) Receive() <-chan []byte
  • func (c *Connection) RetryInterval() time.Duration
  • func (c *Connection) Send(ctx context.Context, buffer []byte) error
  • func (c *Connection) SendFleetAPICommand(ctx context.Context, endpoint string, command interface{}) ([]byte, error)
  • func (c *Connection) VIN() string
  • func (c *Connection) Wakeup(ctx context.Context) error
• type HttpError
  • func (e *HttpError) Error() string
  • func (e *HttpError) MayHaveSucceeded() bool
  • func (e *HttpError) Temporary() bool

Variables

var ErrVehicleNotAwake = protocol.NewError("vehicle not awake", false, false)

Functions

func SendFleetAPICommand

func SendFleetAPICommand(ctx context.Context, client *http.Client, userAgent, authHeader string, url string, command interface{}) ([]byte, error)

Types

type Connection

type Connection struct {
	UserAgent string
	// contains filtered or unexported fields
}

Connection implements the connector.Connector interface by POSTing commands to a server.

func NewConnection

func NewConnection(vin string, authHeader, serverURL, userAgent string) *Connection

NewConnection creates a Connection.

func (*Connection) Close

func (c *Connection) Close()

func (*Connection) PreferredAuthMethod

func (c *Connection) PreferredAuthMethod() connector.AuthMethod

func (*Connection) Receive

func (c *Connection) Receive() <-chan []byte

func (*Connection) RetryInterval

func (c *Connection) RetryInterval() time.Duration

func (*Connection) Send

func (c *Connection) Send(ctx context.Context, buffer []byte) error

func (*Connection) SendFleetAPICommand

func (c *Connection) SendFleetAPICommand(ctx context.Context, endpoint string, command interface{}) ([]byte, error)

Sends a command to a Fleet API REST endpoint. Returns the response body and an error. The response body is not necessarily nil if the error is set.

func (*Connection) VIN

func (c *Connection) VIN() string

func (*Connection) Wakeup

func (c *Connection) Wakeup(ctx context.Context) error

type HttpError

type HttpError struct {
	Code    int
	Message string
}

func (*HttpError) Error

func (e *HttpError) Error() string

func (*HttpError) MayHaveSucceeded

func (e *HttpError) MayHaveSucceeded() bool

func (*HttpError) Temporary

func (e *HttpError) Temporary() bool