common

Documentation

Index

• Constants
• type Component
• type Container
  • func NewContainer(name, imageKey string, args []string, portMaps []types.PortMapping, ...) *Container
  • func (cont *Container) Args() []string
  • func (cont *Container) ID() string
  • func (cont *Container) ImageKey() string
  • func (cont *Container) Name() string
  • func (cont *Container) PortMappings() []types.PortMapping
  • func (cont *Container) Resources() resources.Resources
  • func (cont *Container) ShortID() string
• type NodeComponent
  • func (comp *NodeComponent) Started(simulation bool, startFunction func())
  • func (comp *NodeComponent) Stopped(stopFunction func())
  • func (comp *NodeComponent) Working() bool
• type RemoteNode
  • func NewRemoteNode(IPAddress string, guid guid.GUID) *RemoteNode
  • func (rm *RemoteNode) GUID() *guid.GUID
  • func (rm *RemoteNode) IP() string

Constants

const ContainerShortIDSize = 12

Types

type Component

type Component interface {
	// Starts the component
	Start()
	// Stops the component
	Stop()
	// Verifies if the component is working
	IsWorking() bool
}

Component provides a common interface for all the internal independent components of a node. Providing the common interface of a component.

type Container

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

Container base structure for a container running in the system.

func NewContainer

func NewContainer(name, imageKey string, args []string, portMaps []types.PortMapping,
	resources resources.Resources, id string) *Container

func (*Container) Args

func (cont *Container) Args() []string

func (*Container) ID

func (cont *Container) ID() string

func (*Container) ImageKey

func (cont *Container) ImageKey() string

func (*Container) Name

func (cont *Container) Name() string

func (*Container) PortMappings

func (cont *Container) PortMappings() []types.PortMapping

func (*Container) Resources

func (cont *Container) Resources() resources.Resources

func (*Container) ShortID

func (cont *Container) ShortID() string

type NodeComponent

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

NodeComponent is the base object for all system's internal components.

func (*NodeComponent) Started

func (comp *NodeComponent) Started(simulation bool, startFunction func())

func (*NodeComponent) Stopped

func (comp *NodeComponent) Stopped(stopFunction func())

func (*NodeComponent) Working

func (comp *NodeComponent) Working() bool

type RemoteNode

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

RemoteNode represents a remote CARAVELA node.

func NewRemoteNode

func NewRemoteNode(IPAddress string, guid guid.GUID) *RemoteNode

func (*RemoteNode) GUID

func (rm *RemoteNode) GUID() *guid.GUID

func (*RemoteNode) IP

func (rm *RemoteNode) IP() string