captain

Documentation

Index

• Constants
• Variables
• func ClientBootstrapping() bool
• func ClientReady() bool
• func EstablishCrane(dst *hub.Hub) (*docks.Crane, error)
• func EstablishPublicLane(dst *hub.Hub) (*docks.Crane, error)
• func IsExcepted(ip net.IP) bool
• type BootstrapFile
• type BootstrapFileEntry
• type GossipMsgType
  • func (msgType GossipMsgType) String() string
• type GossipOp
  • func NewGossipOp(controller *docks.CraneControllerTerminal) (*GossipOp, *terminal.Error)
  • func (op *GossipOp) Deliver(c *container.Container) *terminal.Error
  • func (op *GossipOp) End(err *terminal.Error)
  • func (op *GossipOp) Type() string
• type GossipQueryOp
  • func NewGossipQueryOp(t terminal.OpTerminal) (*GossipQueryOp, *terminal.Error)
  • func (op *GossipQueryOp) Deliver(c *container.Container) *terminal.Error
  • func (op *GossipQueryOp) End(err *terminal.Error)
  • func (op *GossipQueryOp) Type() string
• type PublishOp
  • func NewPublishOp(controller *docks.CraneControllerTerminal, identity *cabin.Identity) (*PublishOp, *terminal.Error)
  • func (op *PublishOp) Deliver(c *container.Container) *terminal.Error
  • func (op *PublishOp) End(tErr *terminal.Error)
  • func (op *PublishOp) Result() <-chan *terminal.Error
  • func (op *PublishOp) Type() string
• type SPNStatus
• type SPNStatusName

Constants

const GossipOpType string = "gossip"

const GossipQueryOpType string = "gossip/query"

const PublishOpType string = "publish"

Variables

var (
	CfgOptionEnableSPNKey = "spn/enable"
)

Functions

func ClientBootstrapping

func ClientBootstrapping() bool

ClientBootstrapping signifies if the SPN is currently bootstrapping and requires normal connectivity for download assets.

func ClientReady

func ClientReady() bool

ClientReady signifies if the SPN client is fully ready to handle connections.

func EstablishCrane

func EstablishCrane(dst *hub.Hub) (*docks.Crane, error)

func EstablishPublicLane

func EstablishPublicLane(dst *hub.Hub) (*docks.Crane, error)

func IsExcepted

func IsExcepted(ip net.IP) bool

Types

type BootstrapFile

type BootstrapFile struct {
	Main BootstrapFileEntry
}

type BootstrapFileEntry

type BootstrapFileEntry struct {
	Hubs []string
}

type GossipMsgType

type GossipMsgType uint8

const (
	GossipHubAnnouncementMsg GossipMsgType = 1
	GossipHubStatusMsg       GossipMsgType = 2
)

func (GossipMsgType) String

func (msgType GossipMsgType) String() string

type GossipOp

type GossipOp struct {
	terminal.OpBase
	// contains filtered or unexported fields
}

func NewGossipOp

func NewGossipOp(controller *docks.CraneControllerTerminal) (*GossipOp, *terminal.Error)

func (*GossipOp) Deliver

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

func (*GossipOp) End

func (op *GossipOp) End(err *terminal.Error)

func (*GossipOp) Type

func (op *GossipOp) Type() string

type GossipQueryOp

type GossipQueryOp struct {
	terminal.OpBase
	// contains filtered or unexported fields
}

func NewGossipQueryOp

func NewGossipQueryOp(t terminal.OpTerminal) (*GossipQueryOp, *terminal.Error)

func (*GossipQueryOp) Deliver

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

func (*GossipQueryOp) End

func (op *GossipQueryOp) End(err *terminal.Error)

func (*GossipQueryOp) Type

func (op *GossipQueryOp) Type() string

type PublishOp

type PublishOp struct {
	terminal.OpBase
	// contains filtered or unexported fields
}

func NewPublishOp

func NewPublishOp(controller *docks.CraneControllerTerminal, identity *cabin.Identity) (*PublishOp, *terminal.Error)

func (*PublishOp) Deliver

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

func (*PublishOp) End

func (op *PublishOp) End(tErr *terminal.Error)

func (*PublishOp) Result

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

func (*PublishOp) Type

func (op *PublishOp) Type() string

type SPNStatus

type SPNStatus struct {
	record.Base
	sync.Mutex

	Status             SPNStatusName
	HomeHubID          string
	ConnectedIP        string
	ConnectedTransport string
	ConnectedSince     *time.Time
}

type SPNStatusName

type SPNStatusName string

const (
	StatusFailed     SPNStatusName = "failed"
	StatusDisabled   SPNStatusName = "disabled"
	StatusConnecting SPNStatusName = "connecting"
	StatusConnected  SPNStatusName = "connected"
)