79472b77ca
This is part of ongoing work to make core platform-independent.
BREAKING CHANGE
All private exports from 'angular2/src/core/facade/{lang,collection,exception_handler}' should be replaced with 'angular2/src/facade/{lang,collection,exception_handler}'.
88 lines
3.2 KiB
TypeScript
88 lines
3.2 KiB
TypeScript
import {EventEmitter} from 'angular2/src/facade/async';
|
|
import {NgZone} from 'angular2/src/core/zone/ng_zone';
|
|
export {EventEmitter, Observable} from 'angular2/src/facade/async';
|
|
|
|
/**
|
|
* Message Bus is a low level API used to communicate between the UI and the background.
|
|
* Communication is based on a channel abstraction. Messages published in a
|
|
* given channel to one MessageBusSink are received on the same channel
|
|
* by the corresponding MessageBusSource.
|
|
*/
|
|
export abstract class MessageBus implements MessageBusSource, MessageBusSink {
|
|
/**
|
|
* Sets up a new channel on the MessageBus.
|
|
* MUST be called before calling from or to on the channel.
|
|
* If runInZone is true then the source will emit events inside the angular zone
|
|
* and the sink will buffer messages and send only once the zone exits.
|
|
* if runInZone is false then the source will emit events inside the global zone
|
|
* and the sink will send messages immediately.
|
|
*/
|
|
abstract initChannel(channel: string, runInZone?: boolean): void;
|
|
|
|
/**
|
|
* Assigns this bus to the given zone.
|
|
* Any callbacks attached to channels where runInZone was set to true on initialization
|
|
* will be executed in the given zone.
|
|
*/
|
|
abstract attachToZone(zone: NgZone): void;
|
|
|
|
/**
|
|
* Returns an {@link EventEmitter} that emits every time a message
|
|
* is received on the given channel.
|
|
*/
|
|
abstract from(channel: string): EventEmitter<any>;
|
|
|
|
|
|
/**
|
|
* Returns an {@link EventEmitter} for the given channel
|
|
* To publish methods to that channel just call next (or add in dart) on the returned emitter
|
|
*/
|
|
abstract to(channel: string): EventEmitter<any>;
|
|
}
|
|
|
|
export interface MessageBusSource {
|
|
/**
|
|
* Sets up a new channel on the MessageBusSource.
|
|
* MUST be called before calling from on the channel.
|
|
* If runInZone is true then the source will emit events inside the angular zone.
|
|
* if runInZone is false then the source will emit events inside the global zone.
|
|
*/
|
|
initChannel(channel: string, runInZone: boolean): void;
|
|
|
|
/**
|
|
* Assigns this source to the given zone.
|
|
* Any channels which are initialized with runInZone set to true will emit events that will be
|
|
* executed within the given zone.
|
|
*/
|
|
attachToZone(zone: NgZone): void;
|
|
|
|
/**
|
|
* Returns an {@link EventEmitter} that emits every time a message
|
|
* is received on the given channel.
|
|
*/
|
|
from(channel: string): EventEmitter<any>;
|
|
}
|
|
|
|
export interface MessageBusSink {
|
|
/**
|
|
* Sets up a new channel on the MessageBusSink.
|
|
* MUST be called before calling to on the channel.
|
|
* If runInZone is true the sink will buffer messages and send only once the zone exits.
|
|
* if runInZone is false the sink will send messages immediatly.
|
|
*/
|
|
initChannel(channel: string, runInZone: boolean): void;
|
|
|
|
/**
|
|
* Assigns this sink to the given zone.
|
|
* Any channels which are initialized with runInZone set to true will wait for the given zone
|
|
* to exit before sending messages.
|
|
*/
|
|
attachToZone(zone: NgZone): void;
|
|
|
|
/**
|
|
* Returns an {@link EventEmitter} for the given channel
|
|
* To publish methods to that channel just call next (or add in dart) on the returned emitter
|
|
*/
|
|
to(channel: string): EventEmitter<any>;
|
|
}
|