frontend

Documentation

Overview

Package frontend forwards incoming messages to the instances and vice versa.

Index

• Constants
• type Frontend
  • func New() *Frontend
  • func (f *Frontend) Close() error
  • func (f *Frontend) IsError() bool
  • func (f *Frontend) PairExternal() error
  • func (f *Frontend) ProcessingLen() uint
  • func (f *Frontend) QueueLen() uint
  • func (f *Frontend) SetConfig(externalConfig *config.Handler)
  • func (f *Frontend) SetInstanceManager(manager *instance_manager.Parent)
  • func (f *Frontend) Start() error
  • func (f *Frontend) Status() string

Constants

const (
	CREATED = "created"
	RUNNING = "running"
)

Types

type Frontend

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

func New

func New() *Frontend

New frontend is created

func (*Frontend) Close

func (f *Frontend) Close() error

Close stops all sockets, and clear out the queue, processing

func (*Frontend) IsError

func (f *Frontend) IsError() bool

IsError returns true if the frontend got issue during the running.

func (*Frontend) PairExternal

func (f *Frontend) PairExternal() error

PairExternal runs the external socket as the PAIR. Requires frontend not be running. Requires configuration to be set.

func (*Frontend) ProcessingLen

func (f *Frontend) ProcessingLen() uint

func (*Frontend) QueueLen

func (f *Frontend) QueueLen() uint

func (*Frontend) SetConfig

func (f *Frontend) SetConfig(externalConfig *config.Handler)

func (*Frontend) SetInstanceManager

func (f *Frontend) SetInstanceManager(manager *instance_manager.Parent)

func (*Frontend) Start

func (f *Frontend) Start() error

Start the frontend

func (*Frontend) Status

func (f *Frontend) Status() string