ElectroServer 5 Client: Cocoa-Touch
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
oCElectroServerThis class is used as an entry point for a 2nd level convenient API
oCEsAddBuddiesRequestThis request adds an array of users to your buddy list
oCEsAddBuddiesResponseThis is a response to an AddBuddiesRequest, detailing for each user listed in the request whether the user was added as a buddy or not
oCEsAddRoomOperatorRequestThis request can be made by a current room operator to give operator status to another user in the room
oCEsAggregatePluginMessageEventMost games have a server plugin that contains custom game logic
oCEsAggregatePluginRequestMost games are event driven, and they communicate with the server when an important event happens on the client
oCEsAvailableConnection
oCEsBuddyStatusUpdateActionConstants
oCEsBuddyStatusUpdateEventA buddy is either logged in or not
oCEsConnection
oCEsConnectionAttemptResponseBefore a client can do anything with the server a connection must be established
oCEsConnectionClosedEventWhen a connection closes this event occurs
oCEsConnectionEvent
oCEsConnectionResponseBefore a client can do anything with the server a connection must be established
oCEsCreateOrJoinGameResponseThe QuickJoinGameRequest is used to create a new game on the server, or to join a game that matches the criteria passed in
oCEsCreateRoomRequestThis class represents a highly flexible server request
oCEsCreateRoomVariableRequestThis request creates a room variable
oCEsCrossDomainPolicyRequest
oCEsCrossDomainPolicyResponse
oCEsCryptoTools
oCEsDataTypeConstants
oCEsDeleteRoomVariableRequestThis request deletes a room variable
oCEsDeleteUserVariableRequestThis request deletes a user variable
oCEsDhAesEncryptionContext
oCEsDHInitiateKeyExchangeRequest
oCEsDHPublicNumbersResponse
oCEsDHSharedModulusRequest
oCEsDHSharedModulusResponse
oCEsEncryptionStateChangeEventEvent fired when the encryption state of a client changes
oCEsEngine
oCEsEntity
oCEsErrorTypeConstants
oCEsEsNumber
oCEsEvent
oCEsEventDispatcher
oCEsEventDispatcherEvent
oCEsEventDispatcherListener
oCEsEvictUserFromRoomRequestBy default, the first client joined to a room is the room operator
oCEsFindGamesRequestThis request allows a client to request a list of games that are managed by the server
oCEsFindGamesResponseThe FindGamesRequest allows a client to request a list of games that are managed by the server
oCEsFindZoneAndRoomByNameRequestKnowing 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
oCEsFindZoneAndRoomByNameResponseKnowing 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
oCEsFlattenedEsObject
oCEsFlattenedEsObjectRO
oCEsGatewayKickUserRequest
oCEsGatewayStatistics
oCEsGenericErrorResponseWhen the client sends a request that request can lead to a server error, or just a failure
oCEsGetGameTypesRequestThis request asks the server for a list of registered gametypes
oCEsGetGameTypesResponseWhen a client sends a GetGameTypesRequest it leads to this response, which contains a list of all gameTypes currently registered with GameManager
oCEsGetRoomsInZoneRequestThis request allows the client to ask for a list of all of the rooms in a specific zone
oCEsGetRoomsInZoneResponseThis the response to the GetRoomsInZoneRequest
oCEsGetServerLocalTimeRequestRequests a timestamp from the server
oCEsGetServerLocalTimeResponseResponse to a GetServerLocalTimeRequest
oCEsGetUserCountRequestThis request asks the server for the current number of users logged in
oCEsGetUserCountResponseThis is the response to the GetUserCountRequest
oCEsGetUsersInRoomRequestThis request allows a client to load the list of users in any room
oCEsGetUsersInRoomResponseThis is the response to the GetUsersInRoomRequest
oCEsGetUserVariablesRequestLoads a list of user variables for the specified userName
oCEsGetUserVariablesResponseGetUserVariablesRequest loads a list of user variables for the specified userName, and this class is the response
oCEsGetZonesRequestThis request get the list of zones on the server
oCEsGetZonesResponseWhen a client sends a GetZonesRequest it leads to this response
oCEsIdleTimeoutWarningEventWhen a user is in danger of being kicked from the server due to idleness, this event occurs
oCEsJoinGameRequest
oCEsJoinRoomEventWhen a user is joined successfully to a room this event occurs
oCEsJoinRoomRequestIf you know that a specific room already exists, then you can join it using this request
oCEsJoinZoneEventA zone is a collection of rooms
oCEsLeaveRoomEventWhen a user leaves a room this event occurs
oCEsLeaveRoomRequestWhen a user wants to leave a room it can be done via this request
oCEsLeaveZoneEventWhen a user leaves all rooms in a zone this event occurs
oCEsLoginRequestThis message is sent by the client to the server (after establishing a connection) to attempt to login
oCEsLoginResponseAfter a client attempts a login via the LoginRequest message the server responds with this message
oCEsLogOutRequest
oCEsManagerHelperThis class listens for many ElectroServer events so that it can manage the state of some useful things for you to conveniently access
oCEsMessage
oCEsMessageTranslator
oCEsMessageTypeConstants
oCEsObject
oCEsObjectCodec
oCEsObjectValue
oCEsPingRequest
oCEsPingResponse
oCEsPluginListEntry
oCEsPluginMessageEventThis even occurs when a message from a plugin is received
oCEsPluginRequestThis class is used to send a message to a plugin
oCEsPrivateMessageEventThis event occurs when a client receives a private message from another user
oCEsPrivateMessageRequestThis request is used to send private messages to one or more users at once
oCEsProtocolConfiguration
oCEsProtocolConstants
oCEsPublicMessageEventThis event occurs when a public message is sent to a room to which the client belongs
oCEsPublicMessageRequestThis class is used to send a public message to a room that the user is in
oCEsQueuedMessage
oCEsQuickJoinGameRequestThis request is used to create a new game on the server, or to join a game that matches the criteria passed in
oCEsRegisterUDPConnectionRequest
oCEsRegisterUDPConnectionResponse
oCEsRegistryConnectToPreferredGatewayRequest
oCEsRemoveBuddiesRequestThis request removes a user from a client's buddy list
oCEsRemoveBuddiesResponseThis is a response to a RemoveBuddiesRequest, detailing for each user listed in the request whether the user was removed as a buddy or not
oCEsRemoveRoomOperatorRequestThis request can be made by a current room operator to remove operator status from another user in the room
oCEsRemoveUDPConnectionRequest
oCEsRemoveUDPConnectionResponse
oCEsRequest
oCEsRequestDetails
oCEsResponse
oCEsRoomThis class represents a room on the server
oCEsRoomListEntry
oCEsRoomVariable
oCEsRoomVariableUpdateActionConstants
oCEsRoomVariableUpdateEventWhen a room variable is created, deleted, or updated in a room that the client belongs to then this event occurs
oCEsSearchCriteria
oCEsServer
oCEsServerGame
oCEsServerKickUserEventWhen a user is kicked from the server, this event occurs
oCEsServerStateConstants
oCEsSessionIdleEventThis 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
oCEsSettingsLoader
oCEsSettingsXmlParserThis class is a utility used to parse a standard formatted server settings file
oCEsSocketConnection
oCEsThriftUtil
oCEsTransportType
oCEsUpdateRoomDetailsEventCertain properties of a room can be updated by a user in that room after the room has been created
oCEsUpdateRoomDetailsRequestCertain properties of a room can be updated by a user in that room after the room has been created
oCEsUpdateRoomVariableRequest
oCEsUpdateUserVariableRequestThis request creates or updates a user variable
oCEsUserThis class represents a user on the server
oCEsUserEvictedFromRoomEventBy default, the first client joined to a room is the room operator
oCEsUserListEntry
oCEsUserManagerThis class keeps track of all users that you should know about
oCEsUserServerVariable
oCEsUserUpdateActionConstants
oCEsUserUpdateEventThe user list can change when a client is in a room, and properties on a user can also change
oCEsUserVariable
oCEsUserVariableUpdateActionConstants
oCEsUserVariableUpdateEventThis event occurs whenever a user variable is created, updated, or removed
oCEsUtility
oCEsValidateAdditionalLoginRequestThis request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer
oCEsValidateAdditionalLoginResponseThis request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer
oCEsZone
oCEsZoneListEntry
oCEsZoneManagerThis class manages the list of zones that you should know about based on the rooms that you are in
oCEsZoneUpdateActionConstants
oCEsZoneUpdateEventThis 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
oCmp_int
oCNSData(Base64)
\C<TBase>