neuron

Documentation

Overview

Package neuron will help one to config neuron as per the entries made in the configuration file. This will help in enabling API and UI as well.

Index

• Variables
• func CliMeta() (conf.CliMeta, error)
• func EnableNeuronApi(config conf.ConfigResponse)
• type Config
  • func (c *Config) ConfigureNeuron() error
  • func (c *Config) Init() error

Variables

var (
	ConfResponse = conf.ConfigResponse{}
)

This holds configuration response from ConfigNeuron, this will let other functions/methods take decision further.

Functions

func CliMeta

func CliMeta() (conf.CliMeta, error)

CliMeta will help in configuring neuron amd make it callable from cli, all one has to do is to call this function before using cli.

func EnableNeuronApi

func EnableNeuronApi(config conf.ConfigResponse)

EnableNeuronApi will help in enablement of API.

Types

type Config

type Config struct {
	EnableAPI  bool
	ConfigPath string
}

Config will help one to set few things before they call the methods to initialize/start neuron.

func (*Config) ConfigureNeuron

func (c *Config) ConfigureNeuron() error

ConfigureNeuron will call method ConfigNeuron of config to configure neron, so that it will be operable.

func (*Config) Init

func (c *Config) Init() error

Init will help in configuring neuron, by default other methods takes care of it.