models

Documentation

Overview

Package models describes models.

Index

• type CommandError
• type RequestEnvelope
  • func NewRequestEnvelope(data []byte) *RequestEnvelope
• type ResponseEnvelope
  • func NewResponseEnvelope() *ResponseEnvelope

Types

type CommandError

type CommandError struct {
	Message string `json:"message"`
	Code    int    `json:"code,omitempty"`
	Type    int    `json:"type,omitempty"`
}

CommandError contains a basic command Error.

type RequestEnvelope

type RequestEnvelope struct {
	Payload []byte `json:"payload"`
}

RequestEnvelope contains a payload representing parameters for each operation on a protocol.

func NewRequestEnvelope

func NewRequestEnvelope(data []byte) *RequestEnvelope

NewRequestEnvelope will return an instance of RequestEnvelope.

type ResponseEnvelope

type ResponseEnvelope struct {
	Payload []byte        `json:"payload"`
	Error   *CommandError `json:"error,omitempty"`
}

ResponseEnvelope contains a payload and an error from performing an operation on a protocol.

func NewResponseEnvelope

func NewResponseEnvelope() *ResponseEnvelope

NewResponseEnvelope will return an instance of ResponseEnvelope.