v1_0

Documentation

Index

• Constants
• Variables
• type CommandPacket
• type DataPacket
• type ErrorPacket

Constants

const (
	Command channelID = iota
	Data
	Error
)

List of channels id

Variables

var Channels = map[channelID]string{
	Command: "command",
	Data:    "data",
	Error:   "error",
}

Channels contains channel names

var Instructions = map[string]plugin.Instruction{
	"start_game": plugin.StartSessionInstruction,
	"end_game":   plugin.StopSessionInstruction,
}

Instructions contains instruction names

Types

type CommandPacket

type CommandPacket struct {
	Type   string `json:"type"`
	LinkID string `json:"link_id"`
	Body   struct {
		Command string        `json:"command"`
		Args    []interface{} `json:"args"`
	} `json:"body"`
}

CommandPacket implements the command packet of the protocol.

type DataPacket

type DataPacket struct {
	Type   string `json:"type"`
	LinkId string `json:"link_id"`
	Body   struct {
		Module string      `json:"module"`
		Value  interface{} `json:"value"`
	} `json:"body"`
}

DataPacket implements the data packet of the protocol.

type ErrorPacket

type ErrorPacket struct {
	Type   string `json:"type"`
	LinkID string `json:"link_id"`
	Body   struct {
		Origin string `json:"origin"`
		Reason string `json:"reason"`
	} `json:"body"`
}

ErrorPacket implements the error packet of the protocol.