session

Documentation

Index

• Constants
• Variables
• func DerptunAppDial(ctx context.Context, cfg DerptunAppDialConfig) (*derptun.Mux, func(), error)
• func DerptunAppDialStream(ctx context.Context, cfg DerptunAppDialConfig) (net.Conn, func(), error)
• func DerptunAppServe(ctx context.Context, cfg DerptunAppServeConfig) error
• func DerptunConnect(ctx context.Context, cfg DerptunConnectConfig) error
• func DerptunOpen(ctx context.Context, cfg DerptunOpenConfig) error
• func DerptunServe(ctx context.Context, cfg DerptunServeConfig) error
• func DialAttach(ctx context.Context, cfg AttachDialConfig) (net.Conn, error)
• func Listen(ctx context.Context, cfg ListenConfig) (string, error)
• func Offer(ctx context.Context, cfg OfferConfig) (string, error)
• func Open(ctx context.Context, cfg OpenConfig) error
• func Receive(ctx context.Context, cfg ReceiveConfig) error
• func Send(ctx context.Context, cfg SendConfig) error
• func Share(ctx context.Context, cfg ShareConfig) (string, error)
• type AttachDialConfig
• type AttachListenConfig
• type AttachListener
  • func ListenAttach(ctx context.Context, cfg AttachListenConfig) (*AttachListener, error)
  • func (l *AttachListener) Accept(ctx context.Context) (net.Conn, error)
  • func (l *AttachListener) Close() error
• type BlockReceiveRequest
• type BlockReceiveSink
• type BlockReceiver
• type BlockSource
• type ConcurrentBlockReceiveSink
• type DerptunAppDialConfig
• type DerptunAppServeConfig
• type DerptunConnectConfig
• type DerptunOpenConfig
• type DerptunServeConfig
• type DirectBlockReceiveSink
• type ListenConfig
• type OfferConfig
• type OpenConfig
• type ParallelMode
• type ParallelPolicy
  • func AutoParallelPolicy() ParallelPolicy
  • func DefaultParallelPolicy() ParallelPolicy
  • func FixedParallelPolicy(n int) ParallelPolicy
  • func ParseParallelPolicy(raw string) (ParallelPolicy, error)
• type ReceiveConfig
• type SendConfig
• type ShareConfig
• type State

Constants

const (
	DefaultParallelStripes     = 8
	DefaultParallelInitial     = DefaultParallelStripes
	MaxParallelStripes         = 16
	AutoParallelSamplePeriod   = 500 * time.Millisecond
	AutoParallelGrowthStep     = 2
	AutoParallelTargetFloor    = DefaultParallelStripes
	AutoParallelHoldSamples    = 4
	AutoParallelMinGainMbps    = 50
	AutoParallelMinGainPercent = 10
)

Variables

var ErrPeerAborted = errors.New("peer aborted transfer")

var ErrPeerDisconnected = errors.New("peer disconnected")

var ErrSessionClaimed = errors.New("session already claimed")

var ErrUnknownSession = errors.New("unknown session")

Functions

func DerptunAppDial

func DerptunAppDial(ctx context.Context, cfg DerptunAppDialConfig) (*derptun.Mux, func(), error)

DerptunAppDial claims a derptun app session and returns a connected mux. The returned cleanup function closes the mux and releases the underlying transport resources; callers should call cleanup once they are done with the mux.

func DerptunAppDialStream

func DerptunAppDialStream(ctx context.Context, cfg DerptunAppDialConfig) (net.Conn, func(), error)

DerptunAppDialStream claims a derptun app session and opens one stream on the returned mux. The returned cleanup function closes the mux and transport; the caller still owns the returned stream and may close it independently.

func DerptunAppServe

func DerptunAppServe(ctx context.Context, cfg DerptunAppServeConfig) error

DerptunAppServe serves one derptun app mux at a time and passes each claimed mux to cfg.OnMux. The helper owns the mux and closes it when OnMux returns or the session shuts down; cfg.OnMux should keep running until it is done serving the peer.

func DerptunConnect

func DerptunConnect(ctx context.Context, cfg DerptunConnectConfig) error

func DerptunOpen

func DerptunOpen(ctx context.Context, cfg DerptunOpenConfig) error

func DerptunServe

func DerptunServe(ctx context.Context, cfg DerptunServeConfig) error

func DialAttach

func DialAttach(ctx context.Context, cfg AttachDialConfig) (net.Conn, error)

func Listen

func Listen(ctx context.Context, cfg ListenConfig) (string, error)

func Offer

func Offer(ctx context.Context, cfg OfferConfig) (string, error)

func Open

func Open(ctx context.Context, cfg OpenConfig) error

func Receive

func Receive(ctx context.Context, cfg ReceiveConfig) error

func Send

func Send(ctx context.Context, cfg SendConfig) error

func Share

func Share(ctx context.Context, cfg ShareConfig) (string, error)

Types

type AttachDialConfig

type AttachDialConfig struct {
	Token          string
	Emitter        *telemetry.Emitter
	ForceRelay     bool
	UsePublicDERP  bool
	ParallelPolicy ParallelPolicy
}

type AttachListenConfig

type AttachListenConfig struct {
	Emitter       *telemetry.Emitter
	ForceRelay    bool
	UsePublicDERP bool
}

type AttachListener

type AttachListener struct {
	Token string
	// contains filtered or unexported fields
}

func ListenAttach

func ListenAttach(ctx context.Context, cfg AttachListenConfig) (*AttachListener, error)

func (*AttachListener) Accept

func (l *AttachListener) Accept(ctx context.Context) (net.Conn, error)

func (*AttachListener) Close

func (l *AttachListener) Close() error

type BlockReceiveRequest

type BlockReceiveRequest struct {
	Header      []byte
	PayloadSize int64
	ChunkSize   int
}

type BlockReceiveSink

type BlockReceiveSink interface {
	io.WriterAt
	Close() error
}

type BlockReceiver

type BlockReceiver func(context.Context, BlockReceiveRequest) (BlockReceiveSink, error)

type BlockSource

type BlockSource struct {
	Header      []byte
	HeaderFunc  func() []byte
	Payload     io.ReaderAt
	PayloadSize int64
	ChunkSize   int
	OpenStream  func() (io.ReadCloser, error)
}

type ConcurrentBlockReceiveSink

type ConcurrentBlockReceiveSink interface {
	BlockReceiveSink
	ConcurrentWriteAtSafe() bool
}

ConcurrentBlockReceiveSink is an optional capability for sinks whose WriteAt implementation permits calls from multiple goroutines. Block sinks without this capability remain serialized.

type DerptunAppDialConfig

type DerptunAppDialConfig struct {
	ClientToken string
	Emitter     *telemetry.Emitter
	ForceRelay  bool
}

type DerptunAppServeConfig

type DerptunAppServeConfig struct {
	ServerToken string
	Emitter     *telemetry.Emitter
	ForceRelay  bool
	OnMux       func(context.Context, *derptun.Mux) error
}

type DerptunConnectConfig

type DerptunConnectConfig struct {
	ClientToken string
	StdioIn     io.Reader
	StdioOut    io.Writer
	Emitter     *telemetry.Emitter
	ForceRelay  bool
}

type DerptunOpenConfig

type DerptunOpenConfig struct {
	ClientToken  string
	ListenAddr   string
	BindAddrSink chan<- string
	Emitter      *telemetry.Emitter
	ForceRelay   bool
}

type DerptunServeConfig

type DerptunServeConfig struct {
	ServerToken string
	TargetAddr  string
	Emitter     *telemetry.Emitter
	ForceRelay  bool
}

type DirectBlockReceiveSink

type DirectBlockReceiveSink interface {
	BlockReceiveSink
	DirectWriteBuffer() []byte
	CommitDirectWrite(bytes int, highestEnd int64) error
}

DirectBlockReceiveSink is an optional capability for file-backed sinks that expose the destination's page-cache mapping. Bulk packet receivers copy only authenticated payload into the buffer and report committed bytes in batches.

type ListenConfig

type ListenConfig struct {
	Emitter       *telemetry.Emitter
	TokenSink     chan<- string
	StdioOut      io.Writer
	BlockReceiver BlockReceiver
	ForceRelay    bool
	UsePublicDERP bool
	Trace         *transfertrace.Recorder
	DirectTCPPort int
}

type OfferConfig

type OfferConfig struct {
	Emitter            *telemetry.Emitter
	TokenSink          chan<- string
	StdioIn            io.Reader
	StdioExpectedBytes int64
	BlockSource        *BlockSource
	ForceRelay         bool
	UsePublicDERP      bool
	ParallelPolicy     ParallelPolicy
	Trace              *transfertrace.Recorder
	Progress           func(bytesReceived int64, transferElapsedMS int64)
	DirectTCPPort      int
}

type OpenConfig

type OpenConfig struct {
	Token          string
	BindAddr       string
	BindAddrSink   chan<- string
	Emitter        *telemetry.Emitter
	ForceRelay     bool
	UsePublicDERP  bool
	ParallelPolicy ParallelPolicy
}

type ParallelMode

type ParallelMode string

const (
	ParallelModeFixed ParallelMode = "fixed"
	ParallelModeAuto  ParallelMode = "auto"
)

type ParallelPolicy

type ParallelPolicy struct {
	Mode    ParallelMode
	Initial int
	Cap     int
}

func AutoParallelPolicy

func AutoParallelPolicy() ParallelPolicy

func DefaultParallelPolicy

func DefaultParallelPolicy() ParallelPolicy

func FixedParallelPolicy

func FixedParallelPolicy(n int) ParallelPolicy

func ParseParallelPolicy

func ParseParallelPolicy(raw string) (ParallelPolicy, error)

type ReceiveConfig

type ReceiveConfig struct {
	Token         string
	Emitter       *telemetry.Emitter
	StdioOut      io.Writer
	BlockReceiver BlockReceiver
	ForceRelay    bool
	UsePublicDERP bool
	Trace         *transfertrace.Recorder
	DirectTCPPort int
}

type SendConfig

type SendConfig struct {
	Token              string
	Emitter            *telemetry.Emitter
	StdioIn            io.Reader
	StdioExpectedBytes int64
	BlockSource        *BlockSource
	ForceRelay         bool
	UsePublicDERP      bool
	ParallelPolicy     ParallelPolicy
	Trace              *transfertrace.Recorder
	Progress           func(bytesReceived int64, transferElapsedMS int64)
	DirectTCPPort      int
}

type ShareConfig

type ShareConfig struct {
	Emitter       *telemetry.Emitter
	TokenSink     chan<- string
	TargetAddr    string
	ForceRelay    bool
	UsePublicDERP bool
}

type State

type State string

const (
	StateWaiting             State = "waiting-for-claim"
	StateClaimed             State = "claimed"
	StateProbing             State = "probing-direct"
	StateDirect              State = "connected-direct"
	StateTryingDirect        State = "trying-direct"
	StateDirectFallbackRelay State = "direct-fallback-relay"
	StateRelay               State = "connected-relay"
	StateComplete            State = "stream-complete"
)