From 77e13c055fdc76ff9babbb43754a8f8e44ca6128 Mon Sep 17 00:00:00 2001 From: onur1 Date: Sun, 1 Jan 2023 18:44:45 +0100 Subject: Add documentation --- message.go | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'message.go') diff --git a/message.go b/message.go index 1ffa919..e66b731 100644 --- a/message.go +++ b/message.go @@ -1,11 +1,17 @@ package binproto +// A Message represents a single binproto message. +// +// Each message starts with an header which is a varint encoded +// unsigned 64-bit integer which consists of an ID (first 60-bits) and +// a Channel number (last 4-bits), the rest of the message is payload. type Message struct { ID int Channel rune Data []byte } +// NewMessage returns a new Message. func NewMessage(id int, ch rune, data []byte) *Message { return &Message{ ID: id, -- cgit v1.3.1