server

Documentation

Index

• Constants
• Variables
• type AccessControlList
  • func NewACL() *AccessControlList
  • func (a *AccessControlList) IsAllowed(ip string) bool
  • func (a *AccessControlList) SetACL(ip string, val bool)
  • func (a *AccessControlList) SetupACL()
• type CLI
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) NewNDBServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, ...) (srv Server)
• type HttpServer
  • func NewHttpServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, ...) (srv *HttpServer)
  • func (server *HttpServer) Start()
  • func (server *HttpServer) Stop()
• type HttpsServer
  • func NewHttpsServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, ...) (srv *HttpsServer)
  • func (server *HttpsServer) Start()
  • func (server *HttpsServer) Stop()
• type SOCKET
  • func NewSocketHandler(cfg VConfig, logs ilog.ILOG, stop_chan chan struct{}, wg sync.WaitGroup, ...) *SOCKET
  • func (sock *SOCKET) CloseSocket()
  • func (sock *SOCKET) Start(tcpListen string, tlsListen string, socketPath string, tlscrt string, ...)
• type Server
• type VConfig
  • func NewViperConf(cfgFile string, logs ilog.ILOG) (VConfig, uint32)
• type ViperConfig
  • func (c *ViperConfig) Get(key string) interface{}
  • func (c *ViperConfig) GetBool(key string) bool
  • func (c *ViperConfig) GetInt(key string) int
  • func (c *ViperConfig) GetInt64(key string) int64
  • func (c *ViperConfig) GetString(key string) string
  • func (c *ViperConfig) GetUint32(key string) uint32
  • func (c *ViperConfig) GetUint64(key string) uint64
  • func (c *ViperConfig) IsSet(key string) bool
  • func (c *ViperConfig) PrintConfigsToConsole()
  • func (c *ViperConfig) ReadConfigsFromEnvs()
• type WebMux
• type XNDBServer
  • func NewXNDBServer(db *database.XDatabase, logs ilog.ILOG) *XNDBServer
  • func (srv *XNDBServer) CreateMux() *mux.Router
  • func (srv *XNDBServer) HandlerDel(w http.ResponseWriter, r *http.Request)
  • func (srv *XNDBServer) HandlerGetValByKey(w http.ResponseWriter, r *http.Request)
  • func (srv *XNDBServer) HandlerSet(w http.ResponseWriter, r *http.Request)
  • func (srv *XNDBServer) SetLogLvl(w http.ResponseWriter, r *http.Request)

Constants

const ACK = string(0x06) // Acknowledge 		// 6

const BEL = string(0x07) // Bell, Alert 		// 7

const CAN = string(0x18) // Cancel 				// 24

const COM = ","

const CONFIG_DIR = "cfg"

const CR = "\r"

const CRLF = CR + LF

const CaseAdded = 0x69

const CaseDeleted = 0x00

const CaseDupes = 0xB8

const CasePass = 0xFF

const DATA_DIR = "dat"

const DEFAULT_CONFIG_FILE = "config.toml"

const DEFAULT_LOGLEVEL_INT = ilog.INFO

const DEFAULT_LOGLEVEL_STR = "INFO"

const DEFAULT_LOGS_FILE = "ndb.log"

const DEFAULT_PW_LEN = 32 // admin/username:password

const DEFAULT_SERVER_ADDR = "[::1]"

const DEFAULT_SERVER_SOCKET_PATH = "/tmp/ndb.socket"

const DEFAULT_SERVER_SOCKET_TCP_PORT = "3420"

const DEFAULT_SERVER_SOCKET_TLS_PORT = "4420"

const DEFAULT_SERVER_TCP_PORT = "2420"

const DEFAULT_SERVER_UDP_PORT = "2240"

const DEFAULT_SUB_DICKS = 1000

const DEFAULT_SUPERADMIN = "superadmin"

const DEFAULT_TLS_PRIVKEY = "privkey.pem"

const DEFAULT_TLS_PUBCERT = "fullchain.pem"

const DOT = "."

const ENQ = string(0x05) // Enquiry 			// 5

const EOM = string(0x19) // End of medium 		// 25

const EOT = string(0x04) // End of Transmission // 4

const ESC = string(0x1B) // Escape 				// 27

const ETB = string(0x17) // End of Trans. Block // 23

const ETX = string(0x03) // End of Text 		// 3

const EmptyStr = ""

const FlagSearch = 0x42

const KEY_LIMIT = 1024 * 1024 * 1024 // respond: CAN

socket proto flags

const KEY_PARAM = "key"

const LF = "\n"

const Magic1 = "1" // mem-prof

client proto flags

const Magic2 = "2" // cpu-prof

const MagicA = "A" // add

const MagicD = "D" // del

const MagicG = "G" // get

const MagicL = "L" // list

const MagicS = "S" // set

const MagicZ = "Z" // quit

const NUL = string(0x00) // Null character 		// 0

ASCII control characters [hex: 0 - 1F] // [DEC character code 0-31]

const SEM = ";"

const SOH = string(0x01) // Start of Heading 	// 1

const STX = string(0x02) // Start of Text 		// 2

const SUB = string(0x20) // Substitute  		// 26

const SYN = string(0x16) // Synchronous Idle	// 22

const VAL_LIMIT = 1024 * 1024 * 1024 // respond: CAN

const VK_ACCESS_SUPERADMIN_PASS = "server.superadmin_pass"

const VK_ACCESS_SUPERADMIN_USER = "server.superadmin_user"

VIPER CONFIG KEYS

const VK_LOG_LOGFILE = "log.logfile"

const VK_LOG_LOGLEVEL = "log.loglevel"

const VK_NET_WEBSRV_IDLE_TIMEOUT = "network.websrv_idle_timeout"

const VK_NET_WEBSRV_READ_TIMEOUT = "network.websrv_read_timeout"

const VK_NET_WEBSRV_WRITE_TIMEOUT = "network.websrv_write_timeout"

const VK_SEC_TLS_ENABLED = "security.tls_enabled"

const VK_SEC_TLS_PRIVKEY = "security.tls_priv_key"

const VK_SEC_TLS_PUBCERT = "security.tls_pub_cert"

const VK_SERVER_HOST = "server.bindip"

const VK_SERVER_PORT_TCP = "server.port"

const VK_SERVER_PORT_UDP = "server.port_udp"

const VK_SERVER_SOCKET_ACL = "server.socket_acl"

const VK_SERVER_SOCKET_PATH = "server.socket_path"

const VK_SERVER_SOCKET_PORT_TCP = "server.socket_tcpport"

const VK_SERVER_SOCKET_PORT_TLS = "server.socket_tlsport"

const VK_SETTINGS_BASE_DIR = "settings.base_dir"

const VK_SETTINGS_DATA_DIR = "settings.data_dir"

const VK_SETTINGS_SETTINGS_DIR = "settings.settings_dir"

const VK_SETTINGS_SUB_DICKS = "settings.sub_dicks"

const V_DEFAULT_NET_WEBSRV_IDLE_TIMEOUT = 120

const V_DEFAULT_NET_WEBSRV_READ_TIMEOUT = 5

const V_DEFAULT_NET_WEBSRV_WRITE_TIMEOUT = 10

const V_DEFAULT_SERVER_SOCKET_ACL = "127.0.0.1,::1"

const V_DEFAULT_SUB_DICKS = "100"

const V_DEFAULT_TLS_ENABLED = false

Variables

var (
	RTO int //	ReadTimeout:  time.Duration(RTO) * time.Second,
	WTO int //	WriteTimeout: time.Duration(WTO) * time.Second,
	ITO int // 	IdleTimeout:  time.Duration(ITO) * time.Second,
)

var AVAIL_SUBDICKS = []uint32{10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000, 2000000000, 4000000000}

var (
	DefaultACL map[string]bool // can be set before booting
)

var Prof *prof.Profiler

Types

type AccessControlList

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

func NewACL

func NewACL() *AccessControlList

func (*AccessControlList) IsAllowed

func (a *AccessControlList) IsAllowed(ip string) bool

func (*AccessControlList) SetACL

func (a *AccessControlList) SetACL(ip string, val bool)

func (*AccessControlList) SetupACL

func (a *AccessControlList) SetupACL()

type CLI

type CLI struct {
	// contains filtered or unexported fields

} // end CLI struct

type Factory

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

func NewFactory

func NewFactory() *Factory

func (*Factory) NewNDBServer

func (f *Factory) NewNDBServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, wg sync.WaitGroup, db *database.XDatabase) (srv Server)

type HttpServer

type HttpServer struct {
	// contains filtered or unexported fields

} // end struct HttpServer

func NewHttpServer

func NewHttpServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, wg sync.WaitGroup) (srv *HttpServer)

func (*HttpServer) Start

func (server *HttpServer) Start()

func (*HttpServer) Stop

func (server *HttpServer) Stop()

type HttpsServer

type HttpsServer struct {
	// contains filtered or unexported fields

} // end struct HttpsServer

func NewHttpsServer

func NewHttpsServer(cfg VConfig, ndbServer WebMux, logs ilog.ILOG, stop_chan chan struct{}, wg sync.WaitGroup) (srv *HttpsServer)

func (*HttpsServer) Start

func (server *HttpsServer) Start()

func (*HttpsServer) Stop

func (server *HttpsServer) Stop()

type SOCKET

type SOCKET struct {
	CPUfile *os.File
	// contains filtered or unexported fields
}

func NewSocketHandler

func NewSocketHandler(cfg VConfig, logs ilog.ILOG, stop_chan chan struct{}, wg sync.WaitGroup, db *database.XDatabase) *SOCKET

func (*SOCKET) CloseSocket

func (sock *SOCKET) CloseSocket()

func (*SOCKET) Start

func (sock *SOCKET) Start(tcpListen string, tlsListen string, socketPath string, tlscrt string, tlskey string, tlsenabled bool)

type Server

type Server interface {
	Start()
	Stop()

} // end Server interface

type VConfig

type VConfig interface {
	Get(key string) interface{}
	GetString(key string) string
	GetInt(key string) int
	GetInt64(key string) int64
	GetUint32(key string) uint32
	GetUint64(key string) uint64
	GetBool(key string) bool
	IsSet(key string) bool
}

func NewViperConf

func NewViperConf(cfgFile string, logs ilog.ILOG) (VConfig, uint32)

type ViperConfig

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

func (*ViperConfig) Get

func (c *ViperConfig) Get(key string) interface{}

func (*ViperConfig) GetBool

func (c *ViperConfig) GetBool(key string) bool

func (*ViperConfig) GetInt

func (c *ViperConfig) GetInt(key string) int

func (*ViperConfig) GetInt64

func (c *ViperConfig) GetInt64(key string) int64

func (*ViperConfig) GetString

func (c *ViperConfig) GetString(key string) string

func (*ViperConfig) GetUint32

func (c *ViperConfig) GetUint32(key string) uint32

func (*ViperConfig) GetUint64

func (c *ViperConfig) GetUint64(key string) uint64

func (*ViperConfig) IsSet

func (c *ViperConfig) IsSet(key string) bool

func (*ViperConfig) PrintConfigsToConsole

func (c *ViperConfig) PrintConfigsToConsole()

func (*ViperConfig) ReadConfigsFromEnvs

func (c *ViperConfig) ReadConfigsFromEnvs()

type WebMux

type WebMux interface {
	CreateMux() *mux.Router
	HandlerGetValByKey(w http.ResponseWriter, r *http.Request)
	HandlerSet(w http.ResponseWriter, r *http.Request)
	HandlerDel(w http.ResponseWriter, r *http.Request)
}

type XNDBServer

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

func NewXNDBServer

func NewXNDBServer(db *database.XDatabase, logs ilog.ILOG) *XNDBServer

func (*XNDBServer) CreateMux

func (srv *XNDBServer) CreateMux() *mux.Router

func (*XNDBServer) HandlerDel

func (srv *XNDBServer) HandlerDel(w http.ResponseWriter, r *http.Request)

func (*XNDBServer) HandlerGetValByKey

func (srv *XNDBServer) HandlerGetValByKey(w http.ResponseWriter, r *http.Request)

func (*XNDBServer) HandlerSet

func (srv *XNDBServer) HandlerSet(w http.ResponseWriter, r *http.Request)

func (*XNDBServer) SetLogLvl

func (srv *XNDBServer) SetLogLvl(w http.ResponseWriter, r *http.Request)