nodecmd

Documentation

Overview

Package nodecmd contains the entrypoint for webmesh nodes.

Package nodecmd contains the entrypoint for webmesh nodes.

Package nodecmd contains the entrypoint for webmesh nodes.

Index

• Variables
• func DefaultDaemonSocket() string
• func Execute() error
• func GenBridgeMarkdownDoc(title string, weight int, outfile string) error
• func GenMarkdownDoc(title string, weight int, outfile string) error
• func RunAppDaemon(ctx context.Context, config *Options) error
• type AppDaemon
  • func (app *AppDaemon) Connect(ctx context.Context, req *v1.ConnectRequest) (*v1.ConnectResponse, error)
  • func (app *AppDaemon) Disconnect(ctx context.Context, _ *v1.DisconnectRequest) (*v1.DisconnectResponse, error)
  • func (app *AppDaemon) LeaveCampfire(ctx context.Context, req *v1.LeaveCampfireRequest) (*v1.LeaveCampfireResponse, error)
  • func (app *AppDaemon) Metrics(ctx context.Context, _ *v1.MetricsRequest) (*v1.MetricsResponse, error)
  • func (app *AppDaemon) Query(req *v1.QueryRequest, stream v1.AppDaemon_QueryServer) error
  • func (app *AppDaemon) StartCampfire(ctx context.Context, req *v1.StartCampfireRequest) (*v1.StartCampfireResponse, error)
• type Options
  • func NewOptions() *Options
  • func (o *Options) BindFlags(fs *flag.FlagSet) *Options
  • func (o *Options) DeepCopy() *Options
  • func (o *Options) Marshal() ([]byte, error)
  • func (o *Options) MarshalTo(w io.Writer) error
  • func (o *Options) Validate() error

Variables

var (
	// ErrNotConnected is returned when the node is not connected to the mesh.
	ErrNotConnected = status.Errorf(codes.FailedPrecondition, "not connected")
	// ErrAlreadyConnected is returned when the node is already connected to the mesh.
	ErrAlreadyConnected = status.Errorf(codes.FailedPrecondition, "already connected")
)

Functions

func DefaultDaemonSocket

func DefaultDaemonSocket() string

DefaultDaemonSocket returns the default daemon socket path.

func Execute

func Execute() error

func GenBridgeMarkdownDoc

func GenBridgeMarkdownDoc(title string, weight int, outfile string) error

GenBridgeMarkdownDoc generates the markdown documentation for the bridge commands.

func GenMarkdownDoc

func GenMarkdownDoc(title string, weight int, outfile string) error

GenMarkdownDoc generates markdown documentation for the node command

func RunAppDaemon

func RunAppDaemon(ctx context.Context, config *Options) error

RunAppDaemon runs the app daemon.

Types

type AppDaemon

type AppDaemon struct {
	v1.UnimplementedAppDaemonServer
	// contains filtered or unexported fields
}

AppDaemon is the app daemon RPC server.

func (*AppDaemon) Connect

func (app *AppDaemon) Connect(ctx context.Context, req *v1.ConnectRequest) (*v1.ConnectResponse, error)

func (*AppDaemon) Disconnect

func (app *AppDaemon) Disconnect(ctx context.Context, _ *v1.DisconnectRequest) (*v1.DisconnectResponse, error)

func (*AppDaemon) LeaveCampfire

func (app *AppDaemon) LeaveCampfire(ctx context.Context, req *v1.LeaveCampfireRequest) (*v1.LeaveCampfireResponse, error)

func (*AppDaemon) Metrics

func (app *AppDaemon) Metrics(ctx context.Context, _ *v1.MetricsRequest) (*v1.MetricsResponse, error)

func (*AppDaemon) Query

func (app *AppDaemon) Query(req *v1.QueryRequest, stream v1.AppDaemon_QueryServer) error

func (*AppDaemon) StartCampfire

func (app *AppDaemon) StartCampfire(ctx context.Context, req *v1.StartCampfireRequest) (*v1.StartCampfireResponse, error)

type Options

type Options struct {
	Global *global.Options `yaml:"global,omitempty" json:"global,omitempty" toml:"global,omitempty" mapstructure:"global,omitempty"`

	Mesh     *mesh.Options       `yaml:",inline" json:",inline" toml:",inline" mapstructure:",squash"`
	Bridge   *meshbridge.Options `yaml:"bridge,omitempty" json:"bridge,omitempty" toml:"bridge,omitempty" mapstructure:"bridge,omitempty"`
	Services *services.Options   `yaml:"services,omitempty" json:"services,omitempty" toml:"services,omitempty" mapstructure:"services,omitempty"`
}

Options are the node options.

func NewOptions

func NewOptions() *Options

NewOptions creates new options.

func (*Options) BindFlags

func (o *Options) BindFlags(fs *flag.FlagSet) *Options

BindFlags binds the flags. The options are returned for convenience.

func (*Options) DeepCopy

func (o *Options) DeepCopy() *Options

DeepCopy returns a deep copy of the options.

func (*Options) Marshal

func (o *Options) Marshal() ([]byte, error)

Marshal returns the marshaled options.

func (*Options) MarshalTo

func (o *Options) MarshalTo(w io.Writer) error

func (*Options) Validate

func (o *Options) Validate() error

Validate runs all the validation checks.