cacert-gosigner/pkg/messages/messages.go

/*
Copyright 2022 CAcert Inc.
SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

//go:generate go run github.com/shamaton/msgpackgen

// Package messages contains structure definitions for protocol messages
package messages

import (
	"fmt"
	"time"
)

type CommandCode int

const (
	CmdHealth CommandCode = iota
)

func (c CommandCode) String() string {
	switch c {
	case CmdHealth:
		return "HEALTH"
	default:
		return fmt.Sprintf("unknown (%d)", int(c))
	}
}

type Command struct {
	Code      CommandCode `msgpack:"code"`
	TimeStamp time.Time   `msgpack:"created"`
	Payload   interface{} `msgpack:"payload"` // optional payload
}

type ResponseCode int

const (
	RspError  ResponseCode = -1
	RspHealth ResponseCode = iota
)

type Response struct {
	Code      ResponseCode `msgpack:"code"`
	TimeStamp time.Time    `msgpack:"created"`
	Payload   interface{}  `msgpack:"payload"`
}

type HealthInfo struct {
	Source   string
	Healthy  bool
	MoreInfo map[string]string
}

type HealthResponse struct {
	Version string `msgpack:"version"`
	Healthy bool
	Info    []HealthInfo
}

type ErrorResponse struct {
	Message string `msgpack:"message"`
}