OpenVeo Core server

API Docs for: 7.0.0
Show:

namespaceLoader

Defined in: app/server/loaders/namespaceLoader.js:7
Module: core-loaders

static

Summary

Provides functions to load namespaces from core and plugins configuration.

Item Index

Methods

Properties

Methods

addHandlers

Defined in app/server/loaders/namespaceLoader.js:29

Syntax

addHandlers

(
  • namespace
  • messagesDescriptors
  • pluginPath
)
static

Summary

Attaches handlers to namespace.

Parameters:

  • namespace SocketNamespace

    The socket namespace

  • messagesDescriptors Object

    A list of socket namespace messages with associated controller / action

  • pluginPath String

    The root path of the plugin associated to the namespace used to find controllers associated to messages

Example:

var namespaceLoader = process.require('app/server/loaders/namespaceLoader.js');
var messagesDescriptors = {
  test1: 'app/server/controllers/TestSocketController.test1Action',
  test2: 'app/server/controllers/TestSocketController.test2Action'
};

namespaceLoader.addHandlers(namespace, messagesDescriptors, '/home/openveo/node_modules/openveo-plugin');

Properties

controllers

Defined in app/server/loaders/namespaceLoader.js:17

Syntax

controllers

Object private static

Summary

The list of socket controllers path with associated controller instance.

It is used to instantiate each controller only once.