Package sfs3.client.requests

Class FindRoomsRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.FindRoomsRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class FindRoomsRequest
extends BaseRequest

Retrieves a list of Rooms from the server which match the specified criteria.

By providing a matching expression and a search scope (a Group or the entire Zone), SmartFoxServer can find those Rooms matching the passed criteria and return them by means of the roomFindResult event.

See Also:

• MatchExpression
• SFSEvent.ROOM_FIND_RESULT

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_EXPRESSION
static final String	KEY_FILTERED_ROOMS
static final String	KEY_GROUP
static final String	KEY_LIMIT

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
FindRoomsRequest(MatchExpression expr)
FindRoomsRequest(MatchExpression expr, String groupId)
FindRoomsRequest(MatchExpression expr, String groupId, short limit)	Creates a new FindRoomsRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

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

Field Details

KEY_EXPRESSION

public static final String KEY_EXPRESSION

See Also:

• Constant Field Values

Internal

KEY_GROUP

public static final String KEY_GROUP

See Also:

• Constant Field Values

Internal

KEY_LIMIT

public static final String KEY_LIMIT

See Also:

• Constant Field Values

Internal

KEY_FILTERED_ROOMS

public static final String KEY_FILTERED_ROOMS

See Also:

• Constant Field Values

Internal

Constructor Details

FindRoomsRequest

public FindRoomsRequest(MatchExpression expr,
 String groupId,
 short limit)

Creates a new FindRoomsRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

expr - A matching expression that the system will use to retrieve the Rooms.

groupId - The name of the Group where to search for matching Rooms; if null, the search is performed in the whole Zone.

limit - The maximum size of the list of Rooms that will be returned by the roomFindResult event. If 0, all the found Rooms are returned.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• SFSEvent.ROOM_FIND_RESULT

FindRoomsRequest

public FindRoomsRequest(MatchExpression expr,
 String groupId)

See Also:

• FindRoomsRequest(MatchExpression, String, short)

FindRoomsRequest

public FindRoomsRequest(MatchExpression expr)

See Also:

• FindRoomsRequest(MatchExpression, String, short)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal