Package de.elo.ix.client

Interface EventBusApi

public interface EventBusApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EventBusApi.Bus

Method Summary

Modifier and Type	Method	Description
void	addHandler(IXEventBusHandler evh)	Adds the event handler.
EventBusApi.Bus	getBroadcastBus()	Returns a Bus object for the broadcast bus.
EventBusApi.Bus	getEventBus(long busId)	Returns a Bus object for the given bus ID.
long	getSubscriberId()	Returns the internally used subscriber ID.
EventBusApi.Bus	getUserBus(int userId)	Returns a Bus object for an user bus.
void	onRelogin()	IXConnection has performed a re-login.
EventBusApi.Bus	openEventBusChannel(String channelId)	This function opens an event bus for the given channel ID.
EventBusApi.Bus	openEventBusChannel(String channelId, boolean noForwardToOtherIxs)	This function opens an event bus for the given channel ID.
void	removeHandler(IXEventBusHandler evh)	Deprecated. The handler cannot be removed anymore.

Method Details

getSubscriberId

long getSubscriberId()

Returns the internally used subscriber ID.

Returns:

subscriber ID

addHandler

void addHandler(IXEventBusHandler evh)

Adds the event handler. Only one Handler can be set.

Parameters:

evh - Event handler

removeHandler

@Deprecated
void removeHandler(IXEventBusHandler evh)

Deprecated.

The handler cannot be removed anymore.

Remove the given handler.

Parameters:

evh - Event handler

openEventBusChannel

EventBusApi.Bus openEventBusChannel(String channelId)
                             throws byps.RemoteException

This function opens an event bus for the given channel ID.

Parameters:

channelId - Either an arbitary ID used to create most likely uniqe bus ID. Or null, to create a random bus ID.

Returns:

Bus object.

Throws:

byps.RemoteException

openEventBusChannel

EventBusApi.Bus openEventBusChannel(String channelId,
 boolean noForwardToOtherIxs)
                             throws byps.RemoteException

This function opens an event bus for the given channel ID.

Parameters:

channelId - Either an arbitary ID used to create most likely uniqe bus ID. Or null, to create a random bus ID.

noForwardToOtherIxs - Set this parameter as true, if the messages sent on this bus should not be forwarded to other Indexserver instances. A value of true makes sense, if no other client applications are interested in messages on this bus.

Returns:

Bus object.

Throws:

byps.RemoteException

getEventBus

EventBusApi.Bus getEventBus(long busId)

Returns a Bus object for the given bus ID.

Parameters:

busId - Event bus ID.

Returns:

Bus object.

See Also:

• EventBusApi.Bus.close()

getBroadcastBus

EventBusApi.Bus getBroadcastBus()

Returns a Bus object for the broadcast bus.

Returns:

Bus object.

getUserBus

EventBusApi.Bus getUserBus(int userId)

Returns a Bus object for an user bus.

Parameters:

userId - User ID.

Returns:

Bus object.

onRelogin

void onRelogin()

IXConnection has performed a re-login. This method is internally called. Do not call it directly.