docks

Oct 5, 2023

Changes in this version

+ const WhoAmIType

+ type WhoAmIOp struct

+ func NewWhoAmIOp(t terminal.Terminal) (*WhoAmIOp, *terminal.Error)

+ func (op *WhoAmIOp) Deliver(msg *terminal.Msg) *terminal.Error

+ func (op *WhoAmIOp) HandleStop(err *terminal.Error) (errorToSend *terminal.Error)

+ func (op *WhoAmIOp) Type() string

+ type WhoAmIResponse struct

+ Addr string

+ Timestamp int64

+ func WhoAmI(t terminal.Terminal) (*WhoAmIResponse, *terminal.Error)

Feb 21, 2023

Changes in this version

type ExpansionTerminal

+ func (t *ExpansionTerminal) MarkReachable()

+ func (t *ExpansionTerminal) NeedsReachableCheck(maxCheckAge time.Duration) bool

Dec 20, 2022

Changes in this version

type CapacityTestOp

+ func (op *CapacityTestOp) HandleStop(tErr *terminal.Error) (errorToSend *terminal.Error)

type Crane

+ func (crane *Crane) Send(msg *terminal.Msg, timeout time.Duration) *terminal.Error

type CraneControllerTerminal

+ func (controller *CraneControllerTerminal) HandleAbandon(err *terminal.Error) (errorToSend *terminal.Error)

+ func (controller *CraneControllerTerminal) HandleDestruction(err *terminal.Error)

type CraneTerminal

+ func (t *CraneTerminal) HandleDestruction(err *terminal.Error)

type ExpandOp

+ func (op *ExpandOp) HandleStop(err *terminal.Error) (errorToSend *terminal.Error)

type ExpansionRelayTerminal

+ func (t *ExpansionRelayTerminal) HandleAbandon(err *terminal.Error) (errorToSend *terminal.Error)

+ func (t *ExpansionRelayTerminal) HandleDestruction(err *terminal.Error)

type ExpansionTerminal

+ func (t *ExpansionTerminal) CustomIDFormat() string

+ func (t *ExpansionTerminal) HandleDestruction(err *terminal.Error)

+ type ExpansionTerminalRelayOp struct

+ func (op *ExpansionTerminalRelayOp) Deliver(msg *terminal.Msg) *terminal.Error

+ func (op *ExpansionTerminalRelayOp) HandleStop(err *terminal.Error) (errorToSend *terminal.Error)

+ func (op *ExpansionTerminalRelayOp) Type() string

type LatencyTestClientOp

+ func (op *LatencyTestClientOp) HandleStop(tErr *terminal.Error) (errorToSend *terminal.Error)

Aug 2, 2022

Changes in this version

type ExpandOp

+ func (op *ExpandOp) DeliverHighPriority(c *container.Container) *terminal.Error

type ExpansionRelayTerminal

+ func (t *ExpansionRelayTerminal) DeliverHighPriority(c *container.Container) *terminal.Error

May 9, 2022

Changes in this version

type ExpandOp

+ func (op *ExpandOp) Deliver(c *container.Container) *terminal.Error

+ func (op *ExpandOp) Flush()

type ExpansionRelayTerminal

+ func (t *ExpansionRelayTerminal) Deliver(c *container.Container) *terminal.Error

+ func (t *ExpansionRelayTerminal) Flush()

Apr 13, 2022

Changes in this version

type Crane

+ func (crane *Crane) MarkStoppingRequested()

type NetworkOptimizationState

+ func (netState *NetworkOptimizationState) RequestStoppingSuggested(maxNotSuggestedDuration time.Duration) bool

+ func (netState *NetworkOptimizationState) StopSuggested() bool

+ func (netState *NetworkOptimizationState) StoppingState() (requested, requestedByPeer bool, markedAt time.Time)

+ func (netState *NetworkOptimizationState) StoppingSuggested() bool

type SyncStateMessage

+ RequestStopping bool

Mar 24, 2022

Changes in this version

+ func ResetCraneUpdateHook()

Mar 22, 2022

Changes in this version

+ func Ping(ctx context.Context, t terminal.OpTerminal, timeout time.Duration) (time.Duration, *terminal.Error)

type CraneTerminal

+ func (t *CraneTerminal) IsBeingAbandoned() bool

type ExpansionTerminal

+ func (t *ExpansionTerminal) IsBeingAbandoned() bool

Jan 26, 2022

Changes in this version

+ const CraneMeasurementTTLByCostBase

+ const CraneMeasurementTTLByCostMax

+ const CraneMeasurementTTLByCostMin

+ const CraneMeasurementTTLDefault

+ const SyncStateOpType

type Crane

+ func (crane *Crane) AbortStopping() (aborted bool)

+ func (crane *Crane) IsStopping() bool

+ func (crane *Crane) MarkStopping() (stopping bool)

type CraneControllerTerminal

+ func (controller *CraneControllerTerminal) SyncState(ctx context.Context) *terminal.Error

type NetworkOptimizationState

+ func (netState *NetworkOptimizationState) MarkedStoppingAt() time.Time

+ func (netState *NetworkOptimizationState) UpdateMarkedStoppingAt()

+ type SyncStateMessage struct

+ Stopping bool

+ type SyncStateOp struct

+ func (op *SyncStateOp) Deliver(c *container.Container) *terminal.Error

+ func (op *SyncStateOp) End(tErr *terminal.Error)

+ func (op *SyncStateOp) Type() string

Jan 19, 2022

Changes in this version

+ const NetStatePeriodInterval

type NetworkOptimizationState

+ func (netState *NetworkOptimizationState) GetTrafficStats() (lifetimeBytesIn uint64, lifetimeBytesOut uint64, lifetimeStarted time.Time, ...)

+ func (netState *NetworkOptimizationState) LapsePeriod()

+ func (netState *NetworkOptimizationState) ReportTraffic(bytes uint64, in bool)

Jan 18, 2022

Changes in this version

+ const CraneMeasurementTTL

+ func MeasureHub(ctx context.Context, h *hub.Hub, checkExpiryWith time.Duration) *terminal.Error

type CapacityTestOptions

+ MaxTime time.Duration

type Crane

+ NetState *NetworkOptimizationState

+ Stopping *abool.AtomicBool

+ func (crane *Crane) Authenticated() bool

+ func (crane *Crane) IsMine() bool

type CraneTerminal

+ func (t *CraneTerminal) GrantPermission(grant terminal.Permission)

+ type NetworkOptimizationState struct

+ func (netState *NetworkOptimizationState) LastSuggestedAt() time.Time

+ func (netState *NetworkOptimizationState) UpdateLastSuggestedAt()

Dec 22, 2021

Changes in this version

+ const CapacityTestOpType

+ const LaneCapacityTTL

+ const LaneLatencyTTL

+ const LatencyTestOpType

+ type CapacityTestOp struct

+ func NewCapacityTestOp(t terminal.OpTerminal) (*CapacityTestOp, *terminal.Error)

+ func (op *CapacityTestOp) Deliver(c *container.Container) *terminal.Error

+ func (op *CapacityTestOp) End(tErr *terminal.Error)

+ func (op *CapacityTestOp) Result() <-chan *terminal.Error

+ func (op *CapacityTestOp) Type() string

+ type CapacityTestOptions struct

+ TestVolume int

type Crane

+ func (crane *Crane) GetLaneCapacity() int

+ func (crane *Crane) GetLaneLatency() time.Duration

+ func (crane *Crane) LaneCapacityExpiresAt() time.Time

+ func (crane *Crane) LaneLatencyExpiresAt() time.Time

+ func (crane *Crane) SetLaneCapacity(capacity int)

+ func (crane *Crane) SetLaneLatency(latency time.Duration)

+ func (crane *Crane) Stopped() bool

type CraneControllerTerminal

+ func (controller *CraneControllerTerminal) Flush()

type CraneTerminal

+ func (t *CraneTerminal) Flush()

type ExpansionTerminal

+ func (t *ExpansionTerminal) Flush()

+ type LatencyTestClientOp struct

+ func NewLatencyTestOp(t terminal.OpTerminal) (*LatencyTestClientOp, *terminal.Error)

+ func (op *LatencyTestClientOp) Deliver(c *container.Container) *terminal.Error

+ func (op *LatencyTestClientOp) End(tErr *terminal.Error)

+ func (op *LatencyTestClientOp) Result() <-chan *terminal.Error

+ type LatencyTestOp struct

+ func (op *LatencyTestOp) Deliver(c *container.Container) *terminal.Error

+ func (op *LatencyTestOp) End(tErr *terminal.Error)

+ func (op *LatencyTestOp) Type() string

Nov 17, 2021

Changes in this version

type Crane

+ func (crane *Crane) Transport() *hub.Transport

type CraneTerminal

+ func (t *CraneTerminal) Transport() *hub.Transport

type ExpansionTerminal

+ func (t *ExpansionTerminal) SetChangeNotifyFunc(f func())

Oct 18, 2021

Changes in this version

+ func GetAllAssignedCranes() map[string]*Crane

Sep 24, 2021

Changes in this version

+ const CraneMsgTypeEnd

+ const CraneMsgTypeInfo

+ const CraneMsgTypeRequestHubInfo

+ const CraneMsgTypeStartEncrypted

+ const CraneMsgTypeStartUnencrypted

+ const CraneMsgTypeVerify

+ const ExpandOpType

+ var CraneStatusPublic int8 = 1

+ var ErrDone = errors.New("crane is done")

+ func GetAllCranes() map[string]*Crane

+ func ImportAndVerifyHubInfo(ctx context.Context, hubID string, announcementData, statusData []byte, ...) (h *hub.Hub, forward bool, tErr *terminal.Error)

+ func RegisterCraneUpdateHook(fn func(crane *Crane))

+ type BlockingSubmitQueue struct

+ func NewBlockingSubmitQueue(size int) *BlockingSubmitQueue

+ type BlockingSubmitter struct

type Crane

+ func (crane *Crane) AbandonTerminal(id uint32, err *terminal.Error)

+ func (crane *Crane) EstablishNewTerminal(localTerm terminal.TerminalInterface, initData *container.Container) *terminal.Error

+ func (crane *Crane) LocalAddr() net.Addr

+ func (crane *Crane) NotifyUpdate()

+ func (crane *Crane) Public() bool

+ func (crane *Crane) Publish() error

+ func (crane *Crane) RemoteAddr() net.Addr

+ func (crane *Crane) String() string

+ func (crane *Crane) VerifyConnectedHub() error

+ type CraneControllerTerminal struct

+ Crane *Crane

+ func NewLocalCraneControllerTerminal(crane *Crane, initMsg *terminal.TerminalOpts) (*CraneControllerTerminal, *container.Container, *terminal.Error)

+ func NewRemoteCraneControllerTerminal(crane *Crane, initData *container.Container) (*CraneControllerTerminal, *terminal.TerminalOpts, *terminal.Error)

+ func (controller *CraneControllerTerminal) Abandon(err *terminal.Error)

+ func (controller *CraneControllerTerminal) Deliver(c *container.Container) *terminal.Error

+ type CraneTerminal struct

+ func NewLocalCraneTerminal(crane *Crane, remoteHub *hub.Hub, initMsg *terminal.TerminalOpts, ...) (*CraneTerminal, *container.Container, *terminal.Error)

+ func NewRemoteCraneTerminal(crane *Crane, id uint32, initData *container.Container) (*CraneTerminal, *terminal.TerminalOpts, *terminal.Error)

+ func (t *CraneTerminal) Abandon(err *terminal.Error)

+ func (t *CraneTerminal) Deliver(c *container.Container) *terminal.Error

+ func (t *CraneTerminal) IsAbandoned() bool

+ func (t *CraneTerminal) LocalAddr() net.Addr

+ func (t *CraneTerminal) RemoteAddr() net.Addr

+ type ExpandOp struct

+ func (op *ExpandOp) Abandon(err *terminal.Error)

+ func (op *ExpandOp) Ctx() context.Context

+ func (op *ExpandOp) End(err *terminal.Error)

+ func (op *ExpandOp) FmtID() string

+ func (op *ExpandOp) Type() string

+ type ExpansionRelayTerminal struct

+ func (t *ExpansionRelayTerminal) Abandon(err *terminal.Error)

+ func (t *ExpansionRelayTerminal) Ctx() context.Context

+ func (t *ExpansionRelayTerminal) FmtID() string

+ func (t *ExpansionRelayTerminal) ID() uint32

+ type ExpansionTerminal struct

+ func ExpandTo(t terminal.OpTerminal, routeTo string, encryptFor *hub.Hub) (*ExpansionTerminal, *terminal.Error)

+ func (t *ExpansionTerminal) Abandon(err *terminal.Error)

+ func (t *ExpansionTerminal) Deliver(c *container.Container) *terminal.Error

+ func (t *ExpansionTerminal) End(err *terminal.Error)

+ func (t *ExpansionTerminal) FmtID() string

+ func (t *ExpansionTerminal) HasEnded(end bool) bool

+ func (t *ExpansionTerminal) ID() uint32

+ func (t *ExpansionTerminal) IsAbandoned() bool

+ func (t *ExpansionTerminal) SetID(id uint32)

+ func (t *ExpansionTerminal) Type() string

Aug 6, 2020

Changes in this version

+ const BackOffLimit

+ const BackOffStart

+ const CONV_MONKEY

+ const CONV_MUX

+ const CraneMsgClose

+ const CraneMsgError

+ const CraneMsgTypeAddLineSpace

+ const CraneMsgTypeDiscardLine

+ const CraneMsgTypeHubAnnouncement

+ const CraneMsgTypeHubStatus

+ const CraneMsgTypeNewLine

+ const CraneMsgTypePublishConnection

+ const CraneMsgTypeVerification

+ const HubFeedAnnouncement

+ const HubFeedDistrust

+ const HubFeedStatus

+ const MsgTypeAdminAuth

+ const MsgTypeEcho

+ const MsgTypeEstablishRoute

+ const MsgTypeHop

+ const MsgTypeInfo

+ const MsgTypeLoad

+ const MsgTypePing

+ const MsgTypePublicHubFeed

+ const MsgTypeShutdown

+ const MsgTypeSpeedtest

+ const MsgTypeStats

+ const MsgTypeTunnel

+ const MsgTypeUserAuth

+ const QOTD

+ var CraneStatusPrivate int8 = 0

+ var CraneStatusPublishRequested int8 = 1

+ var CraneStatusPublishVerifying int8 = 2

+ var CraneStatusPublished int8 = 3

+ var CraneStatusStopped int8 = -1

+ var ErrInternalError = errors.New("internal error")

+ func AssignCrane(hubID string, crane *Crane)

+ func EstablishRoute(id *cabin.Identity, dst *hub.Hub)

+ func GetAllControllers() map[string]*CraneController

+ func LaunchShip(ctx context.Context, h *hub.Hub, transport *hub.Transport, ip net.IP) (ships.Ship, error)

+ func RegisterCraneHooks(announcement, status, publish, discontinue craneHookFunc)

+ func RetractCraneByDestination(hubID string)

+ func RetractCraneByID(craneID string) (connectedHub *hub.Hub)

+ type API struct

+ func NewAPI(version int, server, initiator bool) *API

+ func NewClient(version int, dst *hub.Hub) (*API, error)

+ func (portAPI *API) Echo(data []byte) ([]byte, error)

+ func (portAPI *API) Hop(version int, dst *hub.Hub) (*API, error)

+ func (portAPI *API) Info() (*info.Info, error)

+ func (portAPI *API) PublicHubFeed() *api.Call

+ func (portAPI *API) Tunnel(domain string, ip net.IP, protocol packet.IPProtocol, port uint16) (tunnel *api.Call, err error)

+ func (portAPI *API) UserAuth(code *access.Code) error

+ type Conveyor interface

+ AttachConveyorBelts func(lineID string, fromShip, toShip, fromShore, toShore chan *container.Container)

+ Run func()

+ type ConveyorBase struct

+ func (cb *ConveyorBase) AttachConveyorBelts(lineID string, fromShip, toShip, fromShore, toShore chan *container.Container)

+ type ConveyorLine struct

+ ID uint32

+ func NewConveyorLine(crane *Crane, lineID uint32) (*ConveyorLine, error)

+ func (line *ConveyorLine) AddConveyor(conveyor Conveyor)

+ func (line *ConveyorLine) AddLastConveyor(conveyor LastConveyor)

+ type Crane struct

+ ConnectedHub *hub.Hub

+ Controller *CraneController

+ ID string

+ func GetAssignedCrane(hubID string) *Crane

+ func NewCrane(ship ships.Ship, id *cabin.Identity, connectedHub *hub.Hub) (*Crane, error)

+ func (crane *Crane) Start() (err error)

+ func (crane *Crane) Status() int8

+ func (crane *Crane) Stop()

+ type CraneController struct

+ ConnectedHubVerified *abool.AtomicBool

+ Crane *Crane

+ Publishing *abool.AtomicBool

+ func NewCraneController(crane *Crane, send chan *container.Container) *CraneController

+ func (cControl *CraneController) CheckAllLineSpaces()

+ func (cControl *CraneController) Handle(c *container.Container) error

+ func (cControl *CraneController) NewLine(version int) (*ConveyorLine, error)

+ func (cControl *CraneController) PublishConnection() error

+ func (cControl *CraneController) SendHubAnnouncement(msg []byte)

+ func (cControl *CraneController) SendHubStatus(msg []byte)

+ type EncryptionConveyor struct

+ func NewEncryptionConveyor(version int, id *cabin.Identity, dst *hub.Hub) (*EncryptionConveyor, error)

+ func (ec *EncryptionConveyor) Run()

+ type HubRelay struct

+ func (pr *HubRelay) Run()

+ type LastConveyor interface

+ AttachConveyorBelts func(lineID string, fromShip, toShip chan *container.Container)

+ Run func()

+ type LastConveyorBase struct

+ func (cb *LastConveyorBase) AttachConveyorBelts(lineID string, fromShip, toShip chan *container.Container)

+ func (cb *LastConveyorBase) Run()

+ type SimpleConveyorLine struct

+ ID string

+ func NewSimpleConveyorLine() *SimpleConveyorLine

+ func (line *SimpleConveyorLine) AddConveyor(conveyor Conveyor)

+ func (line *SimpleConveyorLine) AddLastConveyor(conveyor LastConveyor)

+ type TunnelRequest struct

+ Domain string

+ IP net.IP

+ Port uint16

+ Protocol packet.IPProtocol

+ func (request *TunnelRequest) Address() string

+ func (request *TunnelRequest) Network() string

+ func (request *TunnelRequest) String() string