starter

Documentation

Overview

Package starter provides a single function that starts up servers for a mounttable and a device manager that is mounted on it.

Index

• func Start(ctx *context.T, args Args) ([]naming.Endpoint, func(), error)
• type Args
• type DeviceArgs
• type NamespaceArgs

Functions

func Start

func Start(ctx *context.T, args Args) ([]naming.Endpoint, func(), error)

Start creates servers for the mounttable and device services and links them together.

Returns the endpoints for the claimable service (empty if already claimed), a callback to be invoked to shutdown the services on success, or an error on failure.

Types

type Args

type Args struct {
	Namespace NamespaceArgs
	Device    DeviceArgs

	// If true, the global namespace will be made available on the
	// mounttable server under "global/".
	MountGlobalNamespaceInLocalNamespace bool
}

type DeviceArgs

type DeviceArgs struct {
	Name            string         // Name to publish the device service under (after claiming).
	ListenSpec      rpc.ListenSpec // ListenSpec for the device server.
	ConfigState     *config.State  // Configuration for the device.
	TestMode        bool           // Whether the device is running in test mode or not.
	RestartCallback func()         // Callback invoked when the device service is restarted.
	PairingToken    string         // PairingToken that a claimer needs to provide.
}

type NamespaceArgs

type NamespaceArgs struct {
	Name            string         // Name to publish the mounttable service under (after claiming).
	ListenSpec      rpc.ListenSpec // ListenSpec for the server.
	PermissionsFile string         // Path to the Permissions file used by the mounttable.
	PersistenceDir  string         // Path to the directory holding persistent acls.
	// Name in the local neighborhood on which to make the mounttable
	// visible. If empty, the mounttable will not be visible in the local
	// neighborhood.
	Neighborhood string
}