tree: 2ff708b3688d6525f707a33e58f7183569a41a59 [path history] [tgz]
  1. connection_type.go
  2. doc.go
  3. message_type.go
  4. opcode.go
  5. payload.go
  6. protocol_binary.go
  8. type.go


import ""

Package protocol contains the constants and types used to communicate with the replay system and its virtual-machine interpreter.

Any changes to the values in this package must also be made to the replay source.


const (
	// ConnectionTypeDeviceInfo is the type of connection used to query device information.
	ConnectionTypeDeviceInfo = ConnectionType(0)
	// ConnectionTypeReplay is the type of connection used to issue a replay.
	ConnectionTypeReplay = ConnectionType(1)
const (
	// MessageTypeGet is sent for a packet that requests a resource.
	MessageTypeGet = MessageType(0)
	// MessageTypePost is sent for a packet containing postback data.
	MessageTypePost = MessageType(1)
const (
	OpCall     = 0
	OpPushI    = 1
	OpLoadC    = 2
	OpLoadV    = 3
	OpLoad     = 4
	OpPop      = 5
	OpStoreV   = 6
	OpStore    = 7
	OpResource = 8
	OpPost     = 9
	OpCopy     = 10
	OpClone    = 11
	OpStrcpy   = 12
	OpExtend   = 13
	OpLabel    = 14

type ConnectionType

type ConnectionType uint8

ConnectionType is sent from the server to the replay system to define the type of connection.

type MessageType

type MessageType uint8

MessageType defines the packet type sent from the replay system to the server.

type Opcode

type Opcode int

Opcode is one of the opcodes supported by the replay virtual machine.

func (Opcode) String

func (t Opcode) String() string

String returns the human-readable name of the opcode.

type Payload

type Payload struct {
	StackSize          uint32         // Maximum number of values.
	VolatileMemorySize uint32         // In bytes.
	Constants          []byte         // The constant buffer.
	Resources          []ResourceInfo // Resources used by this replay payload.
	Opcodes            []byte         // The encoded list of opcodes.

Payload contains all the information to perform a replay. The encoded form is what is passed to the replay system.

func (*Payload) Class

func (*Payload) Class() binary.Class

type ResourceInfo

type ResourceInfo struct {
	ID   string // The resource identifier as a string.
	Size uint32 // The size in bytes of the resource.

ResourceInfo describes a resource used by a Payload.

func (*ResourceInfo) Class

func (*ResourceInfo) Class() binary.Class

type Type

type Type uint32

Type is one of the primitive types supported by the replay virtual machine.

const (
	TypeBool            Type = 0  // A boolean type.
	TypeInt8            Type = 1  // A signed 8-bit integer type.
	TypeInt16           Type = 2  // A signed 16-bit integer type.
	TypeInt32           Type = 3  // A signed 32-bit integer type.
	TypeInt64           Type = 4  // A signed 64-bit integer type.
	TypeUint8           Type = 5  // An unsigned 8-bit integer type.
	TypeUint16          Type = 6  // An unsigned 16-bit integer type.
	TypeUint32          Type = 7  // An unsigned 32-bit integer type.
	TypeUint64          Type = 8  // An unsigned 64-bit integer type.
	TypeFloat           Type = 9  // A 32-bit floating-point number type.
	TypeDouble          Type = 10 // A 64-bit floating-point number type.
	TypeAbsolutePointer Type = 11 // A pointer type that is not remapped by the protocol.
	TypeConstantPointer Type = 12 // A pointer into the constant buffer space.
	TypeVolatilePointer Type = 13 // A pointer into the volatile buffer space.

	TypeVoid Type = 0xffffffff // A non-existant type. Not handled by the protocol.

func (Type) Size

func (t Type) Size(pointerSize int) int

Size returns the size in bytes of the type. pointerSize is the size in bytes of a pointer for the target architecture.

func (Type) String

func (t Type) String() string

String returns the human-readable name of the type.