mbapp

package

v0.0.0-...-d4b7e32 Latest Latest Go to latest Published: Aug 12, 2023 License: MPL-2.0 Imports: 12 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/brendoncarroll/go-p2p

Links

Open Source Insights

README ¶

Message Based Application Platform Protocol

MBAPP (em-bee-app) is a protocol for reliable Asks on top of a SecureSwarm. It also allows passthrough of Tells.

MBAPP supports carrying deadline information, and status codes over the wire. It also performs message fragmentation and reassembly. This allows the application to send messages which exceed the MTU of the underlying transport.

Wire Format

MBAPP prepends a 24 byte header to each message.

Documentation ¶

Index ¶

Constants
type AppError
- func (e AppError) Error() string
type GroupID
type Header
- func ParseMessage(data []byte) (Header, []byte, error)
type Option
- func WithBackground(ctx context.Context) Option
- func WithNumWorkers(n int) Option
type PhaseTime32
- func NewPhaseTime32(x time.Time, units time.Duration) PhaseTime32
- func (pt PhaseTime32) UTC(now time.Time, units time.Duration) time.Time
type Swarm
- func New[A p2p.Addr, Pub any](x p2p.SecureSwarm[A, Pub], mtu int, opts ...Option) *Swarm[A, Pub]

Constants ¶

View Source

const (
	HeaderSize = 6 * 4
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AppError ¶

type AppError struct {
	Addr     p2p.Addr
	Code     uint8
	Request  []byte
	Response []byte
}

func (AppError) Error ¶

func (e AppError) Error() string

type GroupID ¶

type GroupID struct {
	OriginTime PhaseTime32
	Counter    uint32
}

type Header ¶

type Header []byte

Header

|<-        32 bits             ->|

0 | mode bits 24| resp code 8| 1 | origin time 32| 2 | counter 32| 3 | part size 32| 4 | part index 16| part count 16| 5 | timeout or dest time

func ParseMessage ¶

func ParseMessage(data []byte) (Header, []byte, error)

func (h Header) GetCounter() uint32

Word 2

func (h Header) GetErrorCode() uint8

func (h Header) GetOriginTime() PhaseTime32

Word 1

func (h Header) GetPartCount() uint16

func (h Header) GetPartIndex() uint16

Word 4

func (h Header) GetTimeout() time.Duration

func (h Header) GetTotalSize() uint32

Word 3

func (h Header) GroupID() GroupID

func (h Header) IsAsk() bool

Word 0

func (Header) IsReply ¶

func (h Header) IsReply() bool

func (h Header) SetCounter(x uint32)

func (h Header) SetErrorCode(v uint8)

func (h Header) SetIsAsk(yes bool)

func (Header) SetIsReply ¶

func (h Header) SetIsReply(yes bool)

func (h Header) SetOriginTime(pt PhaseTime32)

func (h Header) SetPartCount(v uint16)

func (h Header) SetPartIndex(v uint16)

func (h Header) SetTimeout(v uint32)

Extensions

func (h Header) SetTotalSize(size uint32)

type Option ¶

type Option = func(c *swarmConfig)

func WithBackground ¶

func WithBackground(ctx context.Context) Option

func WithNumWorkers ¶

func WithNumWorkers(n int) Option

type PhaseTime32 ¶

type PhaseTime32 uint32

PhaseTime32 represents a timestamp but relative to another timestamp with a longer memory. If a bound can be placed on the difference in clocks between two processes it can provide higher accuracy with fewer bits.

func NewPhaseTime32 ¶

func NewPhaseTime32(x time.Time, units time.Duration) PhaseTime32

func (PhaseTime32) UTC ¶

func (pt PhaseTime32) UTC(now time.Time, units time.Duration) time.Time

type Swarm ¶

type Swarm[A p2p.Addr, Pub any] struct {
	// contains filtered or unexported fields
}

func New ¶

func New[A p2p.Addr, Pub any](x p2p.SecureSwarm[A, Pub], mtu int, opts ...Option) *Swarm[A, Pub]

func (*Swarm[A, Pub]) Ask ¶

func (s *Swarm[A, Pub]) Ask(ctx context.Context, resp []byte, dst A, req p2p.IOVec) (int, error)

func (*Swarm[A, Pub]) Close ¶

func (s *Swarm[A, Pub]) Close() error

func (*Swarm[A, Pub]) LocalAddrs ¶

func (s *Swarm[A, Pub]) LocalAddrs() []A

func (*Swarm[A, Pub]) LookupPublicKey ¶

func (s *Swarm[A, Pub]) LookupPublicKey(ctx context.Context, x A) (Pub, error)

func (*Swarm[A, Pub]) MTU ¶

func (s *Swarm[A, Pub]) MTU() int

func (*Swarm[A, Pub]) ParseAddr ¶

func (s *Swarm[A, Pub]) ParseAddr(x []byte) (A, error)

func (*Swarm[A, Pub]) PublicKey ¶

func (s *Swarm[A, Pub]) PublicKey() Pub

func (*Swarm[A, Pub]) Receive ¶

func (s *Swarm[A, Pub]) Receive(ctx context.Context, th func(p2p.Message[A])) error

func (*Swarm[A, Pub]) ServeAsk ¶

func (s *Swarm[A, Pub]) ServeAsk(ctx context.Context, fn func(context.Context, []byte, p2p.Message[A]) int) error

func (*Swarm[A, Pub]) Tell ¶

func (s *Swarm[A, Pub]) Tell(ctx context.Context, dst A, msg p2p.IOVec) error

Source Files ¶

View all Source files

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

README ¶

Message Based Application Platform Protocol

Wire Format

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type AppError ¶

func (AppError) Error ¶

type GroupID ¶

type Header ¶

func ParseMessage ¶

func (Header) GetCounter ¶

func (Header) GetErrorCode ¶

func (Header) GetOriginTime ¶

func (Header) GetPartCount ¶

func (Header) GetPartIndex ¶

func (Header) GetTimeout ¶

func (Header) GetTotalSize ¶

func (Header) GroupID ¶

func (Header) IsAsk ¶