protocol

package

v0.17.2 Latest Latest Go to latest Published: Oct 6, 2026 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/OrdalieTech/orb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package protocol implements the bounded, strict JSON stream used by Orb Bridge.

Index ¶

Constants
func Canonical(b []byte) ([]byte, error)
func Counter(s string) (uint64, error)
func Decode(b []byte, v any) error
func NewID() string
func PageLimit(ctx context.Context) int
func Read(r io.Reader) ([]byte, error)
func ValidID(s string) bool
func WithPageLimit(ctx context.Context, limit int) context.Context
func Write(w io.Writer, b []byte) error
type Conn
- func NewConn(stream io.ReadWriteCloser, handler Handler) *Conn
type Handler
type RPCError
- func (e *RPCError) Error() string

Constants ¶

View Source

const (
	Version    = "orb-bridge/1"
	Service    = "orb.instance/1"
	MaxFrame   = 1 << 20
	MaxRecord  = 16 << 10
	MaxDepth   = 64
	MaxPending = 64
	MaxPage    = 128
	MaxOutput  = 4 << 20
)

Variables ¶

This section is empty.

Functions ¶

func Canonical ¶

func Canonical(b []byte) ([]byte, error)

Canonical implements RFC 8785 for object payloads. Counters remain strings; numeric values use IEEE 754 binary64, as required by JCS.

func Counter ¶

func Counter(s string) (uint64, error)

func Decode ¶

func Decode(b []byte, v any) error

Decode rejects unknown arguments as well as JSON ambiguities before binding a schema.

func NewID ¶

func NewID() string

func PageLimit ¶

func PageLimit(ctx context.Context) int

func Read ¶

func Read(r io.Reader) ([]byte, error)

func ValidID ¶

func ValidID(s string) bool

func WithPageLimit ¶

func WithPageLimit(ctx context.Context, limit int) context.Context

func Write ¶

func Write(w io.Writer, b []byte) error

Types ¶

type Conn ¶

type Conn struct {
	// contains filtered or unexported fields
}

func NewConn ¶

func NewConn(stream io.ReadWriteCloser, handler Handler) *Conn

func (*Conn) Call ¶

func (c *Conn) Call(ctx context.Context, method string, params, result any) error

func (*Conn) Close ¶

func (c *Conn) Close() error

func (*Conn) Done ¶

func (c *Conn) Done() <-chan struct{}

func (*Conn) Invoke ¶

func (c *Conn) Invoke(ctx context.Context, method string, params json.RawMessage) (json.RawMessage, error)

func (*Conn) SetFrameLimit ¶

func (c *Conn) SetFrameLimit(limit int)

type Handler ¶

type Handler func(context.Context, string, json.RawMessage) (json.RawMessage, error)

type RPCError ¶

type RPCError struct {
	Code    int             `json:"code"`
	Message string          `json:"message"`
	Data    json.RawMessage `json:"data,omitempty"`
}

func (*RPCError) Error ¶

func (e *RPCError) Error() string

Source Files ¶

View all Source files

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