http

Documentation

Overview

Package http implements a http-like hap server to handle requests and responses.

Index

• func JSONDecode(r io.Reader, v interface{}) error
• func JSONEncode(v interface{}) (*bytes.Buffer, error)
• func ReadJSON(w http.ResponseWriter, r *http.Request, v interface{}) error
• func WriteJSON(w http.ResponseWriter, r *http.Request, v interface{}) error
• type CharacteristicRequest
• type CharacteristicResponse
• type CharacteristicsResponse
• type Config
• type ErrResponse
• type Server
  • func NewServer(c Config) *Server
  • func (s *Server) Accept() (con net.Conn, err error)
  • func (srv *Server) Accessories(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Addr() net.Addr
  • func (srv *Server) Authenticate(next http.Handler) http.Handler
  • func (srv *Server) Characteristics(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Close() error
  • func (srv *Server) Identify(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ListenAndServe(ctx context.Context) error
  • func (s *Server) Port() string

Functions

func JSONDecode

func JSONDecode(r io.Reader, v interface{}) error

func JSONEncode

func JSONEncode(v interface{}) (*bytes.Buffer, error)

func ReadJSON

func ReadJSON(w http.ResponseWriter, r *http.Request, v interface{}) error

func WriteJSON

func WriteJSON(w http.ResponseWriter, r *http.Request, v interface{}) error

Types

type CharacteristicRequest

type CharacteristicRequest struct {
	AccessoryID      uint64      `json:"aid"`
	CharacteristicID uint64      `json:"iid"`
	Value            interface{} `json:"value"`
	Events           interface{} `json:"ev,omitempty"`
}

type CharacteristicResponse

type CharacteristicResponse struct {
	AccessoryID      uint64      `json:"aid"`
	CharacteristicID uint64      `json:"iid"`
	Value            interface{} `json:"value,omitempty"`

	// Status contains the status code. Should be interpreted as integer.
	// The property is omitted if not specified, which makes the payload smaller.
	Status *int `json:"status,omitempty"`
}

type CharacteristicsResponse

type CharacteristicsResponse struct {
	Characteristics []CharacteristicResponse `json:"characteristics"`
}

type Config

type Config struct {
	Port      string
	Context   hap.Context
	Database  db.Database
	Container *accessory.Container
	Device    hap.SecuredDevice
	Mutex     *sync.Mutex
	Emitter   event.Emitter
}

type ErrResponse

type ErrResponse struct {
	Status int `json:status`
}

ErrResponse is an error response.

type Server

type Server struct {
	Mux *http.ServeMux
	// contains filtered or unexported fields
}

func NewServer

func NewServer(c Config) *Server

NewServer returns a server

func (*Server) Accept

func (s *Server) Accept() (con net.Conn, err error)

func (*Server) Accessories

func (srv *Server) Accessories(w http.ResponseWriter, r *http.Request)

func (*Server) Addr

func (s *Server) Addr() net.Addr

func (*Server) Authenticate

func (srv *Server) Authenticate(next http.Handler) http.Handler

Authenticate verfies that a sesson for the request is available.

func (*Server) Characteristics

func (srv *Server) Characteristics(w http.ResponseWriter, r *http.Request)

Characteristics Handles GET and PUT requests for the /characteristics endpoint.

func (*Server) Close

func (s *Server) Close() error

func (*Server) Identify

func (srv *Server) Identify(w http.ResponseWriter, r *http.Request)

TODO respond with 400 if accessory is already paired

HTTP/1.1 400 Bad Request
Content-Type: application/hap+json
Content-Length: <length>
{ "status" : -70401 }

func (*Server) ListenAndServe

func (s *Server) ListenAndServe(ctx context.Context) error

func (*Server) Port

func (s *Server) Port() string