frame

package

v0.0.2 Latest Latest Go to latest Published: Oct 29, 2026 License: MIT Imports: 3 Imported by: 0

Details

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

Repository

github.com/CodeSyncr/nimbus-native

Links

Open Source Insights

Documentation ¶

Overview ¶

Package frame is the dev-mode wire between the device proxy, the relay in `nimbus native dev` and the app process on the laptop: typed, length-prefixed frames over TCP.

Index ¶

Constants
func HelloPayload(role byte, schema uint64) []byte
func ParseHello(p []byte) (role byte, schema uint64, ok bool)
func Reply(id uint32, rc byte, b []byte) []byte
func SplitID(p []byte) (uint32, []byte, bool)
func SplitReply(p []byte) (id uint32, rc byte, b []byte, ok bool)
func WithID(id uint32, b []byte) []byte
func Write(w io.Writer, t Type, payload []byte) error
type Type
- func Read(r io.Reader) (Type, []byte, error)

Constants ¶

View Source

const (
	RoleDevice byte = 1
	RoleApp    byte = 2
)

Roles in a Hello frame.

Variables ¶

This section is empty.

Functions ¶

func HelloPayload ¶

func HelloPayload(role byte, schema uint64) []byte

HelloPayload is a Hello frame's payload.

func ParseHello ¶

func ParseHello(p []byte) (role byte, schema uint64, ok bool)

ParseHello reads a Hello payload.

func Reply ¶

func Reply(id uint32, rc byte, b []byte) []byte

Reply is a call or host-call reply: id, result code (nn.h), bytes.

func SplitID ¶

func SplitID(p []byte) (uint32, []byte, bool)

SplitID splits an id-prefixed payload.

func SplitReply ¶

func SplitReply(p []byte) (id uint32, rc byte, b []byte, ok bool)

SplitReply splits a reply payload.

func WithID ¶

func WithID(id uint32, b []byte) []byte

WithID prefixes a call or host call with its id.

func Write ¶

func Write(w io.Writer, t Type, payload []byte) error

Write sends one frame. Callers serialise writes to a connection.

Types ¶

type Type ¶

type Type uint8

Type says what a frame carries.

const (
	Hello     Type = 1 // role byte + schema hash (u64 LE): who connected
	ToGo      Type = 2 // host → Go async message (device → app)
	FromGo    Type = 3 // Go → host async message (app → device)
	Call      Type = 4 // host → Go sync call: id u32 + request
	CallReply Type = 5 // id u32 + rc u8 + reply
	HostCall  Type = 6 // Go → host sync call: id u32 + request
	HostReply Type = 7 // id u32 + rc u8 + reply
	Reset     Type = 8 // relay → device: a new app process is taking over
)

func Read ¶

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

Read receives one frame.

Source Files ¶

View all Source files

frame.go

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