au.edu.swin.synergy.plugin.rooms
Class BRooms

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.rooms.BRooms

public class BRooms

extends BPlugin

Class taking care of all server side operations.

Author:

Christian Karolos, Shane Fitzgibbon

Field Summary

static String

kDefault Name for default room.

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary

BRooms()

Method Summary

BRoom	getRoom(String name) Get a particular room.
BRoom	getRoomByID(int id) Gets room through the connection ID of user.
Vector	getRooms() Return rooms containing users, files and existing doors.
BChatUser	getUserByID(int id) Returns user corresponding to connection ID
void	onBCommandEvent(Object source, BCommandEvent event) Function receiving all messages dispatched.
void	setup(BStringList params)

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, dispatchEventAndWait, dispatchEventServer, dispatchEventServerAndWait, dispatchEventTo, dispatchEventToAndWait, getDependancies, getKernel, setKernel, setup, unload

Methods inherited from class java.lang.Object

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

Field Detail

kDefault

public static final String kDefault

Name for default room.

Constructor Detail

BRooms

public BRooms()

Method Detail

setup

public void setup(BStringList params)

Overrides:

setup in class BPlugin

getRooms

public Vector getRooms()

Return rooms containing users, files and existing doors.

Returns:

Vector containing room info.

getRoom

public BRoom getRoom(String name)

Get a particular room.

Parameters:

name - Name representing room.

Returns:

Requested room.

Pre Condition:

Room has been registered with server.

getRoomByID

public BRoom getRoomByID(int id)

Gets room through the connection ID of user.

Parameters:

id - Connection ID.

Returns:

Requested room.

Pre Condition:

Room has been registered with server.

getUserByID

public BChatUser getUserByID(int id)

Returns user corresponding to connection ID

Parameters:

id - Connection ID.

Returns:

Requested user.

Pre Condition:

User has logged onto the system.

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

Function receiving all messages dispatched.

Parameters:

source - Originating source of event.

event - Event dispatched.

Overrides:

onBCommandEvent in class BPlugin

Post Condition:

Event has either been handled or ignored.