quickproto

README

Fast golang protocol parser

Supports:

• Headers (Support listed values, IE: Key=[Value, Value, Value])
• Body (Can be encoded/decoded to base64)
• Delimiters

Data is split apart by the delimiter.

Say the delimiter is a $:

The body and header will be split by the delimiter * 4

Each key value pair will be split by the delimiter * 2

Then the key values will be split by the delimiter.

Example:

key1$value1&value2$$key2$value2$$$$BODYBODYBODY

Documentation

Index

• Variables
• func WriteConn(conn net.Conn, msg *Message) error
• type Config
• type Message
  • func NewMessage(delimiter []byte, use_b64 bool) *Message
  • func ReadConn(conn net.Conn, delimiter []byte, use_b64 bool, buf_size int) (*Message, error)
  • func (m *Message) AddContent(content any) error
  • func (m *Message) AddFile(file MessageFile)
  • func (m *Message) AddHeader(key string, value string)
  • func (m *Message) AddRawFile(name string, data []byte)
  • func (m *Message) BodyDelimiter() []byte
  • func (m *Message) ContentLength() int
  • func (m *Message) EndingDelimiter() []byte
  • func (m *Message) FileDelimiter() []byte
  • func (m *Message) Generate() (*Message, error)
  • func (m *Message) HeaderDelimiter() []byte
  • func (m *Message) Parse() (*Message, error)
• type MessageFile

Variables

var STANDARD_DELIM []byte = []byte("$")

Functions

func WriteConn

func WriteConn(conn net.Conn, msg *Message) error

Types

type Config

type Config struct {
	Delimiter []byte
	UseBase64 bool
	BufSize   int
}

type Message

type Message struct {
	Data       []byte
	Delimiter  []byte
	Headers    map[string][]string
	Body       []byte
	Use_Base64 bool
	Files      map[string]MessageFile
}

A Message is a protocol message.

func NewMessage

func NewMessage(delimiter []byte, use_b64 bool) *Message

NewMessage creates a new Message.

func ReadConn

func ReadConn(conn net.Conn, delimiter []byte, use_b64 bool, buf_size int) (*Message, error)

func (*Message) AddContent

func (m *Message) AddContent(content any) error

func (*Message) AddFile

func (m *Message) AddFile(file MessageFile)

func (*Message) AddHeader

func (m *Message) AddHeader(key string, value string)

func (*Message) AddRawFile

func (m *Message) AddRawFile(name string, data []byte)

func (*Message) BodyDelimiter

func (m *Message) BodyDelimiter() []byte

func (*Message) ContentLength

func (m *Message) ContentLength() int

Get content length of the message.

func (*Message) EndingDelimiter

func (m *Message) EndingDelimiter() []byte

func (*Message) FileDelimiter

func (m *Message) FileDelimiter() []byte

func (*Message) Generate

func (m *Message) Generate() (*Message, error)

creates a protocol message. Header is a map of key/value pairs. Body is a base64 encoded byte slice.

func (*Message) HeaderDelimiter

func (m *Message) HeaderDelimiter() []byte

func (*Message) Parse

func (m *Message) Parse() (*Message, error)

parses protocol messages. Header is a map of key/value pairs. Body is a base64 encoded byte slice.

type MessageFile

type MessageFile struct {
	Name string
	Data []byte
}