cube

README

cube

Cube handler interface

Documentation

Index

• Variables
• type Channel
• type Cube
• type Error
• type HandlerInterface
• type InputChannel
• type Message
• type Request
• type Response
  • func NewErrorResponse(requestId string, name string, message string) Response
  • func NewResultResponse(requestId string, result *json.RawMessage) Response

Variables

var (
	ErrorTimeout = errors.New("cube: request timeout")
)

Types

type Channel

type Channel string

type Cube

type Cube interface {
	GetParam(param string) string
	GetClass() string
	GetInstanceId() string

	PublishMessage(channel Channel, message Message) error
	CallMethod(channel Channel, request Request, timeout time.Duration) (*Response, error)

	Stop()

	LogDebug(text string) error
	LogError(text string) error
	LogFatal(text string) error
	LogInfo(text string) error
	LogWarning(text string) error
	LogTrace(text string) error
}

type Error

type Error struct {
	Name    string `json:"name"`
	Message string `json:"description"`
}

type HandlerInterface

type HandlerInterface interface {
	OnInitInstance() []InputChannel
	OnStart(instance Cube) error
	OnStop(instance Cube)
	OnReceiveMessage(instance Cube, channel Channel, message Message)
	OnReceiveRequest(instance Cube, channel Channel, request Request) Response
}

type InputChannel

type InputChannel Channel

type Message

type Message struct {
	Id     string           `json:"id"`
	Method string           `json:"method"`
	Params *json.RawMessage `json:"params"`
}

type Request

type Request struct {
	Method string           `json:"method"`
	Params *json.RawMessage `json:"params"`
}

type Response

type Response struct {
	Id     string           `json:"id"`
	Result *json.RawMessage `json:"result"`
	Error  *Error           `json:"error"`
}

func NewErrorResponse

func NewErrorResponse(requestId string, name string, message string) Response

func NewResultResponse

func NewResultResponse(requestId string, result *json.RawMessage) Response