Package com.electrotank.electroserver5.client.api

Class Summary
EsAddBuddiesRequest This request adds an array of users to your buddy list.
EsAddBuddiesResponse This is a response to an AddBuddiesRequest, detailing for each user listed in the request whether the user was added as a buddy or not.
EsAddRoomOperatorRequest This request can be made by a current room operator to give operator status to another user in the room.
EsAggregatePluginMessageEvent Most games have a server plugin that contains custom game logic.
EsAggregatePluginRequest Most games are event driven, and they communicate with the server when an important event happens on the client.
EsBuddyStatusUpdateEvent A buddy is either logged in or not.
EsConnectionAttemptResponse Before a client can do anything with the server a connection must be established.
EsConnectionClosedEvent When a connection closes this event occurs.
EsConnectionResponse Before a client can do anything with the server a connection must be established.
EsCreateOrJoinGameResponse The QuickJoinGameRequest is used to create a new game on the server, or to join a game that matches the criteria passed in.
EsCreateRoomRequest This class represents a highly flexible server request.
EsCreateRoomVariableRequest This request creates a room variable.
EsCrossDomainPolicyRequest  
EsCrossDomainPolicyResponse  
EsDeleteRoomVariableRequest This request deletes a room variable.
EsDeleteUserVariableRequest This request deletes a user variable.
EsDHInitiateKeyExchangeRequest  
EsDHPublicNumbersResponse  
EsDHSharedModulusRequest  
EsDHSharedModulusResponse  
EsEncryptionStateChangeEvent Event fired when the encryption state of a client changes.
EsEsNumber  
EsEvictUserFromRoomRequest By default, the first client joined to a room is the room operator.
EsFindGamesRequest This request allows a client to request a list of games that are managed by the server.
EsFindGamesResponse The FindGamesRequest allows a client to request a list of games that are managed by the server.
EsFindZoneAndRoomByNameRequest Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone.
EsFindZoneAndRoomByNameResponse Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone.
EsFlattenedEsObject  
EsFlattenedEsObjectRO  
EsGatewayKickUserRequest  
EsGatewayStatistics  
EsGenericErrorResponse When the client sends a request that request can lead to a server error, or just a failure.
EsGetGameTypesRequest This request asks the server for a list of registered gametypes.
EsGetGameTypesResponse When a client sends a GetGameTypesRequest it leads to this response, which contains a list of all gameTypes currently registered with GameManager.
EsGetRoomsInZoneRequest This request allows the client to ask for a list of all of the rooms in a specific zone.
EsGetRoomsInZoneResponse This the response to the GetRoomsInZoneRequest.
EsGetServerLocalTimeRequest Requests a timestamp from the server.
EsGetServerLocalTimeResponse Response to a GetServerLocalTimeRequest.
EsGetUserCountRequest This request asks the server for the current number of users logged in.
EsGetUserCountResponse This is the response to the GetUserCountRequest.
EsGetUsersInRoomRequest This request allows a client to load the list of users in any room.
EsGetUsersInRoomResponse This is the response to the GetUsersInRoomRequest.
EsGetUserVariablesRequest Loads a list of user variables for the specified userName.
EsGetUserVariablesResponse GetUserVariablesRequest loads a list of user variables for the specified userName, and this class is the response.
EsGetZonesRequest This request get the list of zones on the server.
EsGetZonesResponse When a client sends a GetZonesRequest it leads to this response.
EsIdleTimeoutWarningEvent When a user is in danger of being kicked from the server due to idleness, this event occurs.
EsJoinGameRequest  
EsJoinRoomEvent When a user is joined successfully to a room this event occurs.
EsJoinRoomRequest If you know that a specific room already exists, then you can join it using this request.
EsJoinZoneEvent A zone is a collection of rooms.
EsLeaveRoomEvent When a user leaves a room this event occurs.
EsLeaveRoomRequest When a user wants to leave a room it can be done via this request.
EsLeaveZoneEvent When a user leaves all rooms in a zone this event occurs.
EsLoginRequest This message is sent by the client to the server (after establishing a connection) to attempt to login.
EsLoginResponse After a client attempts a login via the LoginRequest message the server responds with this message.
EsLogOutRequest  
EsPingRequest  
EsPingResponse  
EsPluginListEntry  
EsPluginMessageEvent This even occurs when a message from a plugin is received.
EsPluginRequest This class is used to send a message to a plugin.
EsPrivateMessageEvent This event occurs when a client receives a private message from another user.
EsPrivateMessageRequest This request is used to send private messages to one or more users at once.
EsProtocolConfiguration  
EsPublicMessageEvent This event occurs when a public message is sent to a room to which the client belongs.
EsPublicMessageRequest This class is used to send a public message to a room that the user is in.
EsQuickJoinGameRequest This request is used to create a new game on the server, or to join a game that matches the criteria passed in.
EsRegisterUDPConnectionRequest  
EsRegisterUDPConnectionResponse  
EsRegistryConnectToPreferredGatewayRequest  
EsRemoveBuddiesRequest This request removes a user from a client's buddy list.
EsRemoveBuddiesResponse This is a response to a RemoveBuddiesRequest, detailing for each user listed in the request whether the user was removed as a buddy or not.
EsRemoveRoomOperatorRequest This request can be made by a current room operator to remove operator status from another user in the room.
EsRemoveUDPConnectionRequest  
EsRemoveUDPConnectionResponse  
EsRequestDetails  
EsRoomListEntry  
EsRoomVariable  
EsRoomVariableUpdateEvent When a room variable is created, deleted, or updated in a room that the client belongs to then this event occurs.
EsSearchCriteria  
EsServerGame  
EsServerKickUserEvent When a user is kicked from the server, this event occurs.
EsSessionIdleEvent This event occurs if the client has been idle (not sending any messages to the server) for an amount of time that is equal to or greater than the maximum time allowed for idling.
EsUpdateRoomDetailsEvent Certain properties of a room can be updated by a user in that room after the room has been created.
EsUpdateRoomDetailsRequest Certain properties of a room can be updated by a user in that room after the room has been created.
EsUpdateRoomVariableRequest  
EsUpdateUserVariableRequest This request creates or updates a user variable.
EsUserEvictedFromRoomEvent By default, the first client joined to a room is the room operator.
EsUserListEntry  
EsUserServerVariable  
EsUserUpdateEvent The user list can change when a client is in a room, and properties on a user can also change.
EsUserVariable  
EsUserVariableUpdateEvent This event occurs whenever a user variable is created, updated, or removed.
EsUtility  
EsValidateAdditionalLoginRequest This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer.
EsValidateAdditionalLoginResponse This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer.
EsZoneListEntry  
EsZoneUpdateEvent This event occurs when the room list changes in a zone that your client can see, or when a public property on a room in that zone changes.
 

Enum Summary
EsBuddyStatusUpdateAction  
EsDataType  
EsErrorType  
EsMessageType  
EsProtocol  
EsRoomVariableUpdateAction  
EsServerState  
EsUserUpdateAction  
EsUserVariableUpdateAction  
EsZoneUpdateAction  
 



Copyright © 2007-2010 Electrotank, Inc. All Rights Reserved.