Package sfs3.client.requests

Class ExtensionRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.ExtensionRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class ExtensionRequest
extends BaseRequest

Sends a command to the server-side Extension attached to the Zone or to a Room.

This request is used to send custom commands from the client to a server-side Extension, be it a Zone-level or Room-level Extension. Also, the extensionResponse event is used by the server to send Extension commands/responses to the client.

Read the SmartFoxServer 3 documentation about server-side Extension for more informations.

By default ExtensionRequest is sent via TCP but it's also possible to use UDP protocol instead, provided a UDP connection is already established. (see the SmartFox.isUdpConnected()).

See Also:

• SmartFox.connectUdp()
• SmartFox.isUdpConnected()
• SFSEvent.EXTENSION_RESPONSE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_CMD
static final String	KEY_PARAMS
static final String	KEY_ROOM

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
ExtensionRequest(String extCmd)
ExtensionRequest(String extCmd, ISFSObject params)
ExtensionRequest(String extCmd, ISFSObject params, Room room)
ExtensionRequest(String extCmd, ISFSObject params, Room room, TransportType txType)	Creates a new ExtensionRequest 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_CMD

public static final String KEY_CMD

See Also:

• Constant Field Values

Internal

KEY_PARAMS

public static final String KEY_PARAMS

See Also:

• Constant Field Values

Internal

KEY_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

Internal

Constructor Details

ExtensionRequest

public ExtensionRequest(String extCmd,
 ISFSObject params,
 Room room,
 TransportType txType)

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

Parameters:

extCmd - The name of the command which identifies an action that should be executed by the server-side Extension.

params - An instance of SFSObject containing custom data to be sent to the Extension. Can be null if no data needs to be sent.

room - If null, the specified command is sent to the current Zone server-side Extension; if not null, the command is sent to the server-side Extension attached to the passed Room.

txType - specify the protocol to use. Default is TCP.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• SFSObject

ExtensionRequest

public ExtensionRequest(String extCmd,
 ISFSObject params,
 Room room)

See Also:

• ExtensionRequest(String, ISFSObject, Room, TransportType)

ExtensionRequest

public ExtensionRequest(String extCmd,
 ISFSObject params)

See Also:

• ExtensionRequest(String, ISFSObject, Room, TransportType)

ExtensionRequest

public ExtensionRequest(String extCmd)

See Also:

• ExtensionRequest(String, ISFSObject, Room, TransportType)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal