Module: EventBus

Classes

ketaEventBus

ketaEventBusProvider

Methods

• <inner> create(config) → {ketaEventBus}
• <inner> getConfig() → {Object}
• <inner> getDefaultConfig() → {Object}
• <inner> getInstance() → {eb}
• <inner> inOfflineMode() → {boolean}

<inner> create(config) → {ketaEventBus}

Creates an EventBus instance with given config, which is merged with the default config.

Parameters:

Name	Type	Description
config	Object	config to use in created EventBus instance

Source:

• services/event-bus.js, line 158

Returns:

ketaEventBus EventBus created

Examples

angular.module('exampleApp', ['keta.services.EventBus'])
    .config(function(ketaEventBusProvider) {
        // create with default config
        var eventBus = ketaEventBusProvider.create();
    });

angular.module('exampleApp', ['keta.services.EventBus'])
    .config(function(ketaEventBusProvider) {
        // create with custom id
        var eventBus = ketaEventBusProvider.create({id: 'myEventBus'});
    });

angular.module('exampleApp', ['keta.services.EventBus'])
    .config(function(ketaEventBusProvider) {

        // create with custom config
        // in this case it's exactly the default config
        var eventBus = ketaEventBusProvider.create({
            id: 'kiwibus',
            url: 'https://localhost:10443/kiwibus',
            reconnect: true,
            reconnectTimeout: 5,
            requestTimeout: 10
        });

    });

<inner> getConfig() → {Object}

Returns effective config of EventBus instance.

Source:

• services/event-bus.js, line 64

Returns:

Object effective configuration

Example

angular.module('exampleApp', ['keta.services.EventBus'])
    .controller('ExampleController', function(ketaEventBus) {
        var effectiveConfig = ketaEventBus.getConfig();
    });

<inner> getDefaultConfig() → {Object}

Returns default config used to merge in EventBus instance create method.

Source:

• services/event-bus.js, line 40

Returns:

Object default configuration

Example

angular.module('exampleApp', ['keta.services.EventBus'])
    .controller('ExampleController', function(ketaEventBus) {
        var defaultConfig = ketaEventBus.getDefaultConfig();
    });

<inner> getInstance() → {eb}

Returns EventBus instance.

Source:

• services/event-bus.js, line 88

Returns:

eb EventBus instance

Example

angular.module('exampleApp', ['keta.services.EventBus'])
    .controller('ExampleController', function(ketaEventBus) {
        var instance = ketaEventBus.getInstance();
    });

<inner> inOfflineMode() → {boolean}

Returns true if EventBus is configured to be in offline mode.

Source:

• services/event-bus.js, line 106

Returns:

boolean true if in offline mode

Example

angular.module('exampleApp', ['keta.services.EventBus'])
    .controller('ExampleController', function(ketaEventBus) {
        var inOfflineMode = ketaEventBus.inOfflineMode();
    });