Class Broadcast

java.lang.Object

Broadcast

public final class Broadcast
extends Object

Represents a collection of ServerResponses to be sent from the server to one or more client(s) as the result of a user registration or deregistration, or in response to a command received from some client. The methods in ServerModel which correspond to these activities each return an instance of this class. As outlined in the protocol specification, each one of these activities results in at least one response being sent to a client.

We will test each of the aforementioned ServerModel methods by checking whether the Broadcasts they return exactly match the reference Broadcast constructed in the test case, except for tests that expect an error code, for which the error messages may be different. See ClientConnectionTest for examples.

You should not edit this file.

See Also:

ServerModel, ServerResponse, ClientConnectionTest

Constructor Summary

Constructors

Constructor and Description
Broadcast() Constructs an empty Broadcast.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
void	send(int userId, ServerResponse response) Adds a ServerResponse to the list of responses to be broadcast to the user with specified user ID.
void	sendAll(Broadcast other) Appends all responses in other to this broadcast, excluding any duplicates sent to the same user ID in both broadcasts.
void	sendError(int userId, String senderNick, ServerErrorCode errorCode, String errorMessage) A convenience method which constructs an ERROR response and sends it to the user with specified user ID, exactly as if using send(int, ServerResponse).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Broadcast

public Broadcast()

Constructs an empty Broadcast.

Method Detail

send

public void send(int userId,
        ServerResponse response)

Adds a ServerResponse to the list of responses to be broadcast to the user with specified user ID. Note that the prefix of the command may be different from the ID of the user receiving the command: it is often necessary to relay commands sent by one client to another one. This method will not cause a duplicate response to be sent to the client; if the given response is already being sent to userId in this broadcast, this method has no effect.

Parameters:

userId - the ID of the user to send to

response - the response to send

sendError

public void sendError(int userId,
             String senderNick,
             ServerErrorCode errorCode,
             String errorMessage)

A convenience method which constructs an ERROR response and sends it to the user with specified user ID, exactly as if using send(int, ServerResponse).

Parameters:

userId - the ID of the user to send to

senderNick - the user's nick

errorCode - the error code to send

errorMessage - the (optional) error message to include

sendAll

public void sendAll(Broadcast other)

Appends all responses in other to this broadcast, excluding any duplicates sent to the same user ID in both broadcasts. In short, merges the two broadcasts together.

Parameters:

other - the broadcast to merge

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object