bridge

Documentation

Index

• Variables
• type Bridge
  • func NewBridge(ctx context.Context, wg *sync.WaitGroup, logger *zap.Logger, serial Serial, ...) (*Bridge, error)
  • func (b *Bridge) Close() error
  • func (b *Bridge) StreamHandler(stream network.Stream)
• type Opts
• type Serial

Variables

var ProtocolID = protocol.ID("/liblora-bridge/0.0.1")

ProtocolID is the protocol ID of the liblora bridge

Types

type Bridge

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

Bridge allows authorized peers to open a stream and read/write data through the LoRa bridge

func NewBridge

func NewBridge(ctx context.Context, wg *sync.WaitGroup, logger *zap.Logger, serial Serial, opt Opts) (*Bridge, error)

NewBridge returns an initialized bridge, suitable for use a LibP2P protocol

func (*Bridge) Close

func (b *Bridge) Close() error

Close is used to shutdown the bridge serial interface

func (*Bridge) StreamHandler

func (b *Bridge) StreamHandler(stream network.Stream)

StreamHandler is used to open a bi-directional stream.

type Opts

type Opts struct {
	AuthorizedPeers map[peer.ID]bool // empty means allow all
}

Opts allows configuring the bridge

type Serial

type Serial interface {
	Write([]byte) (int, error)
	Available() (int, error)
	Read([]byte) (int, error)
	Flush() error
	Close() error
}

Serial is an interface to provide easy testing of the lora protocol