bridge

package

v0.13.0 Latest Latest Go to latest Published: Sep 27, 2026 License: MIT Imports: 17 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 ¶

Rendered for

Overview ¶

Package bridge supplies explicit filesystem and IPC adapters for Orb Bridge.

Index ¶

func Dial(ctx context.Context, path string, auth Auth, handler protocol.Handler, ...) (*protocol.Conn, error)
func InstanceFromContext(ctx context.Context) string
func Listen(ctx context.Context, path string, b *bridge.Bridge, adminSecret string, ...) (func(), error)
type Auth
type Store
- func OpenStore(path string, quota int) (*Store, error)
- func OpenStoreWithDocument(path string, quota int, document host.Document) (*Store, error)
type Welcome

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Dial ¶

func Dial(ctx context.Context, path string, auth Auth, handler protocol.Handler, generation func(string) error) (*protocol.Conn, error)

func InstanceFromContext ¶

func InstanceFromContext(ctx context.Context) string

func Listen ¶

func Listen(ctx context.Context, path string, b *bridge.Bridge, adminSecret string, admin protocol.Handler, outbound protocol.Handler) (func(), error)

Types ¶

type Auth ¶

type Auth struct {
	Credential string `json:"credential"`
	InstanceID string `json:"instance_id,omitempty"`
	BootID     string `json:"boot_id,omitempty"`
}

type Store ¶

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

func OpenStore ¶

func OpenStore(path string, quota int) (*Store, error)

func OpenStoreWithDocument ¶

func OpenStoreWithDocument(path string, quota int, document host.Document) (*Store, error)

OpenStoreWithDocument keeps native single-owner locking and quotas while the supplied document owns persistence. Closing it never closes the database.

func (*Store) Close ¶

func (s *Store) Close() error

func (*Store) Load ¶

func (s *Store) Load() ([]byte, error)

func (*Store) Remove ¶ added in v0.12.1

func (s *Store) Remove() error

Remove deletes the stored document; the store stays locked until Close.

func (*Store) Save ¶

func (s *Store) Save(b []byte) (err error)

type Welcome ¶

type Welcome struct {
	Generation string `json:"generation,omitempty"`
}

Source Files ¶

View all Source files

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