r00t2/go_wireproto
1
0
Fork 0
Code Issues Pull Requests Activity
go_wireproto/README.adoc
brent saner cefca8ad91
v1.0.3 
FIXED:
* Link in README
* ReadConnResponse was not properly reading in the response status byte
  before checking the checksum, leading to receiving/parsing Response
  messages from a net.Conn *always* failing with an errs.ErrBadHdr.
  This has been rectified.
2025-09-30 14:15:00 -04:00

2.5 KiB
Raw Blame History

Go WireProto API Documentation

Table of Contents

1. Reference

In addition to the documentation found in this document and the specification, library usage documentation can be found at the Golang module documentation page:

Go Reference

2. License

This library is licensed for use, inclusion, and distribution under the "3-Clause BSD" license.

Full License 
Unresolved directive in <stdin> - include::LICENSE[]

3. TODO

The following are a wishlist or things planned that may come in later versions.

  • More clear errors

    • Currently during e.g. UnmarshalBinary calls, just an io.EOF will be returned if the buffer is exhausted early. This may be able to be a little more context-helpful by using the Err* errors.

  • Confirmation of read/write sizes in buffers

    • The sizes they should be are known, there’s no reason to not confirm it.

  • Goroutines

    • This of course won’t work for serializing and keeping order of children (e.g. RG ⇒ Record); that’d still need to be ordered, but it will allow for parallel parsing of those children. Should benchmark, though; it may not be worth it.

  • context.Context support for Read* and Write* funcs

    • This is a relatively low priority as the passed net.Conn will likely return an error if its own context is canceled. This can be handled in the caller downstream.

  • .Append*() methods to append any type to any parent type. e.g. <Response>.AppendFVP(<FieldValuePair>) would append an FVP to the most recent ResponseRecord to the most recent ResponseRecordGroup (or create if they don’t exist), <Response>.AppendRecord(…​) for appending a record to most recent record group etc.

  • Better/more strict interfaces

  • Maps should be any, not interface{} values