packet

package

v0.0.0-...-c7544f2 Latest Latest Go to latest Published: Jan 6, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mraerino/atem-go

Links

Open Source Insights

Documentation ¶

Index ¶

func MarshalCommand(cmd Command) ([]byte, error)
type Command
- func UnmarshalCommand(data []byte) (Command, error)
type Flags
- func FlagsFrom(masks ...Flags) Flags
- func (f Flags) Debug() logrus.Fields
- func (f Flags) Has(mask Flags) bool
type Message
- func Deserialize(log logrus.FieldLogger, buf *bytes.Buffer) (Message, error)
- func (m *Message) Serialize(buf *bytes.Buffer)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MarshalCommand ¶

func MarshalCommand(cmd Command) ([]byte, error)

MarshalCommand will serialize a command including the length field

Types ¶

type Command ¶

type Command interface {
	Slug() string
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
}

func UnmarshalCommand ¶

func UnmarshalCommand(data []byte) (Command, error)

UnmarshalCommand will deserialize a command from bytes (excluding length field)

type Flags ¶

type Flags uint8

const (
	FlagNeedACK Flags = 1 << iota
	FlagInit
	FlagRetrans
	FlagHello
	FlagACK
)

func FlagsFrom ¶

func FlagsFrom(masks ...Flags) Flags

func (Flags) Debug ¶

func (f Flags) Debug() logrus.Fields

func (Flags) Has ¶

func (f Flags) Has(mask Flags) bool

type Message ¶

type Message struct {
	Flags     Flags  // max: 5 bit
	Length    uint16 // max: 11 bit
	SessionID uint16
	AckID     uint16
	SeqNum    uint16

	Commands []Command
}

func Deserialize ¶

func Deserialize(log logrus.FieldLogger, buf *bytes.Buffer) (Message, error)

func (*Message) Serialize ¶

func (m *Message) Serialize(buf *bytes.Buffer)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmds

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL