battery

README

goactor

Documentation

Index

• func Error(err error, code string, metadata ...map[string]string) *errors.Error
• func GetLOGO() string
• func Version() string
• type Application
  • func NewApp(opts ...Option) *Application
  • func (app *Application) Decoder() facade.PacketDecoder
  • func (app *Application) DieChan() chan bool
  • func (app *Application) Encoder() facade.PacketEncoder
  • func (app *Application) IsFrontend() bool
  • func (app *Application) IsRunning() bool
  • func (app *Application) MessageEncoder() facade.MessageEncoder
  • func (app *Application) NodeMode() ServerMode
  • func (app *Application) Register(s facade.Service)
  • func (app *Application) Serializer() facade.Serializer
  • func (app *Application) Shutdown()
  • func (app *Application) Start()
• type Option
  • func WithClusterMode() Option
  • func WithDebug() Option
  • func WithGate(acceptors []facade.Acceptors) Option
• type ServerMode

Functions

func Error

func Error(err error, code string, metadata ...map[string]string) *errors.Error

Error creates a new error with a code, message and metadata

func GetLOGO

func GetLOGO() string

func Version

func Version() string

Types

type Application

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

func NewApp

func NewApp(opts ...Option) *Application

func (*Application) Decoder

func (app *Application) Decoder() facade.PacketDecoder

func (*Application) DieChan

func (app *Application) DieChan() chan bool

func (*Application) Encoder

func (app *Application) Encoder() facade.PacketEncoder

func (*Application) IsFrontend

func (app *Application) IsFrontend() bool

func (*Application) IsRunning

func (app *Application) IsRunning() bool

func (*Application) MessageEncoder

func (app *Application) MessageEncoder() facade.MessageEncoder

func (*Application) NodeMode

func (app *Application) NodeMode() ServerMode

func (*Application) Register

func (app *Application) Register(s facade.Service)

func (*Application) Serializer

func (app *Application) Serializer() facade.Serializer

func (*Application) Shutdown

func (app *Application) Shutdown()

func (*Application) Start

func (app *Application) Start()

type Option

type Option func(app *Application) error

Option is a function on the options for a connection.

func WithClusterMode

func WithClusterMode() Option

func WithDebug

func WithDebug() Option

func WithGate

func WithGate(acceptors []facade.Acceptors) Option

type ServerMode

type ServerMode byte

ServerMode represents a server mode

const (

	// Cluster represents a server running with connection to other servers
	Cluster ServerMode
	// Standalone represents a server running without connection to other servers
	Standalone
)