controllers

Documentation

Index

• Constants
• type Action
• type ActionsHandler
  • func (handler *ActionsHandler) RegisterAction(actionName string, action Action)
  • func (handler *ActionsHandler) RegisterConnectedAction(action Action)
  • func (handler *ActionsHandler) RegisterDisconnectedAction(action Action)
  • func (handler *ActionsHandler) RegisterErrorAction(action Action)
• type Context
  • func (context *Context) Join(room string)
  • func (context *Context) Leave(room string)
  • func (context *Context) Params(key string) interface{}
  • func (context *Context) ParamsBool(key string) bool
  • func (context *Context) ParamsFloat64(key string, fallback float64) float64
  • func (context *Context) ParamsInt(key string, fallback int) int
  • func (context *Context) ParamsStr(key string) string
  • func (context *Context) PrepareRender(viewName string) *views.Renderer
  • func (context *Context) Property(key string) interface{}
  • func (context *Context) Rooms() []string
  • func (context *Context) SetErrorResult(status string, err error)
  • func (context *Context) SetProperty(key string, value interface{})
  • func (context *Context) SetSuccessResult(content interface{})
  • func (context *Context) SingleJoin(room string)
• type Controllable
• type ControllerHandler
• type Event
  • func (event *Event) Broadcast(server *socketio.Server)
• type Hook
• type HooksHandler
  • func (handler *HooksHandler) RegisterBeforeActionHook(beforeActionHook Hook)
• type Manager
  • func (manager *Manager) BroadcastEvent(nsp string, room string, eventName string, view interface{}, ...)
  • func (manager *Manager) RegisterController(nsp string, controllable Controllable)
  • func (manager *Manager) Serve(port string, httpHandler func())
  • func (manager *Manager) Setup(viewsManager *views.Manager)
• type Result
  • func (result *Result) Content() interface{}
  • func (result *Result) ErrorMessage() string
  • func (result *Result) Set(content interface{}, status string, err error)
  • func (result *Result) Status() string
  • func (result *Result) StatusError() bool
  • func (result *Result) StatusSuccess() bool
  • func (result *Result) StatusUnauthorized() bool

Constants

const StatusError = "error"

StatusError used to represent errored request

const StatusInternalServerError = "internalservererror"

StatusInternalServerError used to represent unhandled exception request

const StatusSuccess = "success"

StatusSuccess used to represent success request

const StatusUnauthorized = "unauthorized"

StatusUnauthorized used to represent unauthorized request

Types

type Action

type Action func(*Context)

Action is alias for func(*Connection) (interface{}, error)

type ActionsHandler

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

ActionsHandler used to mange callbacks for controllers

func (*ActionsHandler) RegisterAction

func (handler *ActionsHandler) RegisterAction(actionName string, action Action)

RegisterAction used to register action

func (*ActionsHandler) RegisterConnectedAction

func (handler *ActionsHandler) RegisterConnectedAction(action Action)

RegisterConnectedAction used to register connected action

func (*ActionsHandler) RegisterDisconnectedAction

func (handler *ActionsHandler) RegisterDisconnectedAction(action Action)

RegisterDisconnectedAction used to register disconnected action

func (*ActionsHandler) RegisterErrorAction

func (handler *ActionsHandler) RegisterErrorAction(action Action)

RegisterErrorAction used to register error action

type Context

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

Context used to represent context with properties and params

func (*Context) Join

func (context *Context) Join(room string)

Join used to join socketio room

func (*Context) Leave

func (context *Context) Leave(room string)

Leave used to leave socketio room

func (*Context) Params

func (context *Context) Params(key string) interface{}

Params used to retrieve params value

func (*Context) ParamsBool

func (context *Context) ParamsBool(key string) bool

ParamsBool used to retrieve params value in bool

func (*Context) ParamsFloat64

func (context *Context) ParamsFloat64(key string, fallback float64) float64

ParamsFloat64 used to retrieve params value in float64

func (*Context) ParamsInt

func (context *Context) ParamsInt(key string, fallback int) int

ParamsInt used to retrieve params value in int

func (*Context) ParamsStr

func (context *Context) ParamsStr(key string) string

ParamsStr used to retrieve params value in string

func (*Context) PrepareRender

func (context *Context) PrepareRender(viewName string) *views.Renderer

func (*Context) Property

func (context *Context) Property(key string) interface{}

Property used to retrieve context property value

func (*Context) Rooms

func (context *Context) Rooms() []string

Rooms used to retrieve all connection's rooms

func (*Context) SetErrorResult

func (context *Context) SetErrorResult(status string, err error)

SetErrorResult used to halt controller's chain and acknowledge request with status and error

func (*Context) SetProperty

func (context *Context) SetProperty(key string, value interface{})

SetProperty used to set property that can used across the context

func (*Context) SetSuccessResult

func (context *Context) SetSuccessResult(content interface{})

SetSuccessResult used to halt controller's chain and acknowledge request with content

func (*Context) SingleJoin

func (context *Context) SingleJoin(room string)

SingleJoin used to join socketio room while leaving other joined rooms

type Controllable

type Controllable interface {
	RegisterHooksAndActions(*HooksHandler, *ActionsHandler)
}

Controllable is the interface for all controllers implementing RegisterBeforeHooks and RegisterActions

type ControllerHandler

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

ControllerHandler used to handle controller

type Event

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

Event used as medium of communication

func (*Event) Broadcast

func (event *Event) Broadcast(server *socketio.Server)

Broadcast used to broadcast event

type Hook

type Hook func(string, *Context)

Hook is alias for Hook

type HooksHandler

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

HooksHandler used to mange callbacks for controllers

func (*HooksHandler) RegisterBeforeActionHook

func (handler *HooksHandler) RegisterBeforeActionHook(beforeActionHook Hook)

RegisterBeforeActionHook used to add before hook

type Manager

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

Manager is singleton manager for controller module

func (*Manager) BroadcastEvent

func (manager *Manager) BroadcastEvent(nsp string, room string, eventName string, view interface{}, parameters helpers.H)

BroadcastEvent used to broadcast event

func (*Manager) RegisterController

func (manager *Manager) RegisterController(nsp string, controllable Controllable)

RegisterController used to register controller

func (*Manager) Serve

func (manager *Manager) Serve(port string, httpHandler func())

Serve used to serve

func (*Manager) Setup

func (manager *Manager) Setup(viewsManager *views.Manager)

Setup used to setup cotroller manager

type Result

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

Result used to wrap request result

func (*Result) Content

func (result *Result) Content() interface{}

Content used to retrieve result's content

func (*Result) ErrorMessage

func (result *Result) ErrorMessage() string

ErrorMessage used to retrieve result's error message

func (*Result) Set

func (result *Result) Set(content interface{}, status string, err error)

Set used to set content, status and error

func (*Result) Status

func (result *Result) Status() string

Status used to retrieve result's status

func (*Result) StatusError

func (result *Result) StatusError() bool

StatusError used to check if request is errored

func (*Result) StatusSuccess

func (result *Result) StatusSuccess() bool

StatusSuccess used to check if request is success

func (*Result) StatusUnauthorized

func (result *Result) StatusUnauthorized() bool

StatusUnauthorized used to check if request is unauthorized