api

Documentation

Overview

Package api contains the external API for Horde

Index

• Constants
• func NewHordeAPIService(store storage.DataStore, fieldMask model.FieldMaskParameters, ...) apipb.HordeServer
• type DownstreamMessageSender

Constants

const AuthKey = contextKey("auth")

AuthKey is the context key for the authentication method in the context

const UserKey = contextKey("user")

UserKey is the context key for the user object in the context

Functions

func NewHordeAPIService

func NewHordeAPIService(store storage.DataStore,
	fieldMask model.FieldMaskParameters,
	outputManager output.Manager,
	dataStoreClient datastore.DataStoreClient,
	messageSender DownstreamMessageSender, firmwareImageStore storage.FirmwareImageStore) apipb.HordeServer

NewHordeAPIService creates a new HordeAPIServer

Types

type DownstreamMessageSender

type DownstreamMessageSender interface {
	Send(model.Device, model.DownstreamMessage) error
}

DownstreamMessageSender is a type capable of sending messages downstream.