queue

Documentation

Overview

Package queue implements a boldDB backed queue for MDM Commands.

Index

• Constants
• func MarshalDeviceCommand(c *DeviceCommand) ([]byte, error)
• func MarshalQueuedCommand(cq *QueueCommandQueued) ([]byte, error)
• func PublishCommandQueued(pub pubsub.Publisher, udid, uuid string) error
• func UnmarshalDeviceCommand(data []byte, c *DeviceCommand) error
• type Command
• type DeviceCommand
• type Option
  • func WithLogger(logger log.Logger) Option
  • func WithoutHistory() Option
• type QueueCommandQueued
  • func UnmarshalQueuedCommand(data []byte) (*QueueCommandQueued, error)
• type Store
  • func NewQueue(db *bolt.DB, pubsub pubsub.PublishSubscriber, opts ...Option) (*Store, error)
  • func (db *Store) Clear(ctx context.Context, event mdm.CheckinEvent) error
  • func (db *Store) DeviceCommand(udid string) (*DeviceCommand, error)
  • func (db *Store) Next(ctx context.Context, resp mdm.Response) ([]byte, error)
  • func (db *Store) Save(cmd *DeviceCommand) error

Constants

const (
	DeviceCommandBucket = "mdm.DeviceCommands"

	CommandQueuedTopic = "mdm.CommandQueued"
)

Functions

func MarshalDeviceCommand

func MarshalDeviceCommand(c *DeviceCommand) ([]byte, error)

func MarshalQueuedCommand

func MarshalQueuedCommand(cq *QueueCommandQueued) ([]byte, error)

func PublishCommandQueued

func PublishCommandQueued(pub pubsub.Publisher, udid, uuid string) error

func UnmarshalDeviceCommand

func UnmarshalDeviceCommand(data []byte, c *DeviceCommand) error

Types

type Command

type Command struct {
	UUID    string
	Payload []byte

	CreatedAt    time.Time
	LastSentAt   time.Time
	Acknowledged time.Time

	TimesSent int

	LastStatus     string
	FailureMessage []byte
}

type DeviceCommand

type DeviceCommand struct {
	DeviceUDID string
	Commands   []Command

	// These are going to scale great. We'll have to see.
	Completed []Command
	Failed    []Command
	NotNow    []Command
}

type Option

type Option func(*Store)

func WithLogger

func WithLogger(logger log.Logger) Option

func WithoutHistory

func WithoutHistory() Option

type QueueCommandQueued

type QueueCommandQueued struct {
	DeviceUDID  string
	CommandUUID string
}

func UnmarshalQueuedCommand

func UnmarshalQueuedCommand(data []byte) (*QueueCommandQueued, error)

type Store

type Store struct {
	*bolt.DB
	// contains filtered or unexported fields
}

func NewQueue

func NewQueue(db *bolt.DB, pubsub pubsub.PublishSubscriber, opts ...Option) (*Store, error)

func (*Store) Clear

func (db *Store) Clear(ctx context.Context, event mdm.CheckinEvent) error

func (*Store) DeviceCommand

func (db *Store) DeviceCommand(udid string) (*DeviceCommand, error)

func (*Store) Next

func (db *Store) Next(ctx context.Context, resp mdm.Response) ([]byte, error)

func (*Store) Save

func (db *Store) Save(cmd *DeviceCommand) error