tldmsg

Documentation

Overview

This is a simple package to implement the TLDMP protocol.

More info on the protocol: https://files.almaember.com/tld-messages.txt

Index

• type Error
  • func (self Error) Error() string
• type Message
  • func ReadFromStream(rd io.Reader) (Message, error)
  • func (msg Message) WriteToStream(wr io.Writer) error

Types

type Error

type Error uint8

Error type specifically for tldmsg

const (
	// The input didn't contain a full message
	InputTooShort Error = iota
)

func (Error) Error

func (self Error) Error() string

Get a textual representation of the error

type Message

type Message struct {
	// The type of the message
	MType uint8
	// The contents
	Content []byte
}

A simple message structure.

The content length is implied from the length of the slice.

func ReadFromStream

func ReadFromStream(rd io.Reader) (Message, error)

Read a message from a stream

func (Message) WriteToStream

func (msg Message) WriteToStream(wr io.Writer) error

Write a message to a stream