Class RemoteServerEvent

java.lang.Object

net.user1.union.core.event.BaseEvent

net.user1.union.core.event.RemoteServerEvent

All Implemented Interfaces:

Externalizable, Serializable, Event, RemoteEvent

public class RemoteServerEvent
extends BaseEvent
implements RemoteEvent, Externalizable

RemoteServerEvent is a simple data class used to pass information from the server to registered event-listeners when a remote server event occurs. The RemoteServerEvent class also defines constants representing the available server events. To register for a remote server event, use the Server class's addRemoteEventListener() method.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_ROOMDEF	This property contains the RoomDef when REMOTE_ROOM_CREATED is dispatched.
static final String	REMOTE_ROOM_CREATED	Dispatched when a clustered room has been created on a node.
static final String	REMOTE_ROOM_REMOVED	Dispatched when a clustered master room has been removed from a node.

Fields inherited from class net.user1.union.core.event.BaseEvent

m_eventProperties

Constructor Summary

Constructors

Constructor	Description
RemoteServerEvent()	Constructor.
RemoteServerEvent(String nodeID, String roomID)	Constructor.
RemoteServerEvent(String nodeID, String roomID, Map<String,Object> props)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getNodeID()	Returns the ID of the node where the event originated.
String	getRoomID()	Returns the ID of the room involved in the event.
void	readExternal(ObjectInput in)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class net.user1.union.core.event.BaseEvent

getProperty, isCanceled, preventDefault

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.user1.union.core.event.Event

getProperty, isCanceled, preventDefault

Field Details

REMOTE_ROOM_CREATED

public static final String REMOTE_ROOM_CREATED

Dispatched when a clustered room has been created on a node. When the room is automatically created on other nodes (eg. slave room in master-slave) the event will not be dispatched by those nodes.

See Also:

• Constant Field Values

REMOTE_ROOM_REMOVED

public static final String REMOTE_ROOM_REMOVED

Dispatched when a clustered master room has been removed from a node. The removal of a room in slave mode never causes this event to be dispatched.

See Also:

• Constant Field Values

PROP_ROOMDEF

public static final String PROP_ROOMDEF

This property contains the RoomDef when REMOTE_ROOM_CREATED is dispatched.

See Also:

• Constant Field Values

Constructor Details

RemoteServerEvent

public RemoteServerEvent()

Constructor.

RemoteServerEvent

public RemoteServerEvent(String nodeID,
 String roomID)

Constructor.

RemoteServerEvent

public RemoteServerEvent(String nodeID,
 String roomID,
 Map<String,Object> props)

Constructor.

Method Details

getNodeID

public String getNodeID()

Returns the ID of the node where the event originated.

Returns:

the ID of the node where the event originated

getRoomID

public String getRoomID()

Returns the ID of the room involved in the event.

Returns:

the ID of the room involved in the event

toString

public String toString()

Overrides:

toString in class Object

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException