mnemosyned

Documentation

Overview

Package mnemosyned is server implementation of Mnemosyne session store.

Index

• Constants
• func TestDaemon(t *testing.T, opts TestDaemonOpts) (net.Addr, io.Closer)
• type Daemon
  • func NewDaemon(opts *DaemonOpts) (*Daemon, error)
  • func (d *Daemon) Addr() net.Addr
  • func (d *Daemon) Close() (err error)
  • func (d *Daemon) Run() (err error)
• type DaemonOpts
• type TestDaemonOpts

Constants

const (
	// DefaultTTL is session time to live default value.
	DefaultTTL = 24 * time.Minute
	// DefaultTTC is time to clear default value.
	DefaultTTC = 1 * time.Minute
)

const (
	// StorageEngineInMemory is not implemented yet.
	StorageEngineInMemory = "in_memory"
	// StorageEnginePostgres keeps session within postgres database.
	StorageEnginePostgres = "postgres"
	// StorageEngineRedis is not implemented yet.
	StorageEngineRedis = "redis"
)

Functions

func TestDaemon

func TestDaemon(t *testing.T, opts TestDaemonOpts) (net.Addr, io.Closer)

TestDaemon returns address of fully started in-memory daemon and closer to close it.

Types

type Daemon

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

Daemon represents single daemon instance that can be run.

func NewDaemon

func NewDaemon(opts *DaemonOpts) (*Daemon, error)

NewDaemon allocates new daemon instance using given options.

func (*Daemon) Addr

func (d *Daemon) Addr() net.Addr

Addr returns net.Addr that rpc service is listening on.

func (*Daemon) Close

func (d *Daemon) Close() (err error)

Close implements io.Closer interface.

func (*Daemon) Run

func (d *Daemon) Run() (err error)

Run starts daemon and all services within.

type DaemonOpts

type DaemonOpts struct {
	IsTest          bool
	SessionTTL      time.Duration
	SessionTTC      time.Duration
	Monitoring      bool
	TLS             bool
	TLSCertFile     string
	TLSKeyFile      string
	Storage         string
	PostgresAddress string
	Logger          log.Logger
	RPCOptions      []grpc.ServerOption
	RPCListener     net.Listener
	DebugListener   net.Listener
}

DaemonOpts it is constructor argument that can be passed to the NewDaemon constructor function.

type TestDaemonOpts

type TestDaemonOpts struct {
	StoragePostgresAddress string
}

TestDaemonOpts set of options that are used with TestDaemon instance.