controllers

Documentation

Index

• 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) ParamsInt(key string, fallback int) int
  • func (context *Context) ParamsStr(key string) string
  • func (context *Context) ParamsWithFallback(key string, fallback interface{}) interface{}
  • func (context *Context) Property(key string) interface{}
  • func (context *Context) PropertyWithFallback(key string, fallback interface{}) interface{}
  • func (context *Context) Rooms() []string
  • func (context *Context) SetProperty(key string, value interface{})
  • func (context *Context) SingleJoin(room string)
• type Controllable
• type ControllerHandler
• type ErrorsView
• type Event
  • func (event *Event) Broadcast(server *socketio.Server)
• type Hook
• type HooksHandler
  • func (handler *HooksHandler) RegisterBeforeHook(beforeHook 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()
• type NetworkError

Types

type Action

type Action func(*Context) (interface{}, error)

Action is handler 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) 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) ParamsWithFallback

func (context *Context) ParamsWithFallback(key string, fallback interface{}) interface{}

ParamsWithFallback used to retrieve params value with a fallback

func (*Context) Property

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

Property used to retrieve context property value

func (*Context) PropertyWithFallback

func (context *Context) PropertyWithFallback(key string, fallback interface{}) interface{}

PropertyWithFallback used to retrieve context property value with a fallback

func (*Context) Rooms

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

Rooms used to retrieve all connection's rooms

func (*Context) SetProperty

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

SetProperty used to set property that can used across the context

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 ErrorsView

type ErrorsView struct {
	Messages string
}

ErrorsView is view template for controller errors

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) error

Hook is alias for Hook

type HooksHandler

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

HooksHandler used to mange callbacks for controllers

func (*HooksHandler) RegisterBeforeHook

func (handler *HooksHandler) RegisterBeforeHook(beforeHook Hook)

RegisterBeforeHook 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()

Setup used to setup cotroller manager

type NetworkError

type NetworkError struct {
	Status int
	Error  string
}

NetworkError encapsulates network error with status code and error message