| 
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use SOCMessage | |
|---|---|
| soc.client | |
| soc.message | |
| soc.robot | |
| soc.server | |
| Uses of SOCMessage in soc.client | 
|---|
| Methods in soc.client with parameters of type SOCMessage | |
|---|---|
 void | 
SOCDisplaylessPlayerClient.treat(SOCMessage mes)
Treat the incoming messages.  | 
 void | 
SOCAccountClient.treat(SOCMessage mes)
Treat the incoming messages  | 
 void | 
SOCPlayerClient.MessageTreater.treat(SOCMessage mes,
      boolean isPractice)
Treat the incoming messages.  | 
| Uses of SOCMessage in soc.message | 
|---|
| Subclasses of SOCMessage in soc.message | |
|---|---|
 class | 
SOCAcceptOffer
This message means that the player is accepting an offer.  | 
 class | 
SOCAdminPing
This message is a way for the admin to test if a robot is connected and running  | 
 class | 
SOCAdminReset
This message allows the admin to reset a robot player remotely  | 
 class | 
SOCAuthRequest
Authentication request, to connect and check password without creating or joining a game or channel.  | 
 class | 
SOCBankTrade
This message means that a player wants to trade with the bank or a port.  | 
 class | 
SOCBCastTextMsg
This message contains a text message for everyone connected  | 
 class | 
SOCBoardLayout
This message contains the board layout information.  | 
 class | 
SOCBoardLayout2
This message contains the board's layout information and its encoding version.  | 
 class | 
SOCBoardSpecialEdge
This message from the server to clients announces that an edge on the game board has become a Special Edge, or is no longer a Special Edge.  | 
 class | 
SOCBuildRequest
This message, from client to server, says which piece type the current player wants to build.  | 
 class | 
SOCBuyCardRequest
This message means that the player wants to buy a development card.  | 
 class | 
SOCCancelBuildRequest
This message type has five possible meanings, depending on game state and direction sent:  | 
 class | 
SOCChangeFace
This message says that a player is changing the face icon.  | 
 class | 
SOCChannels
This message lists all the chat channels on a server.  | 
 class | 
SOCChoosePlayer
This message from client to server has a few purposes, all related to robbing: After a server's SOCChoosePlayerRequest, 
     it says which player the current player wants to
     steal from. | 
 class | 
SOCChoosePlayerRequest
This message from server to client asks a player to choose a player to steal from.  | 
 class | 
SOCClearOffer
This message means that the player is retracting an offer.  | 
 class | 
SOCClearTradeMsg
This message means that the server wants the trade message cleared.  | 
 class | 
SOCCreateAccount
This message is a request to create an account  | 
 class | 
SOCDebugFreePlace
This debug message from client to server means that a player is asking to place a piece on the board, without spending resources or checking the current player.  | 
 class | 
SOCDeleteChannel
This message means that a chat channel has been destroyed.  | 
 class | 
SOCDeleteGame
This message means that a soc game has been destroyed.  | 
 class | 
SOCDevCardAction
This message from the server means that a player is drawing or playing
 a development card; response to SOCPlayDevCardRequest. | 
 class | 
SOCDevCardCount
This message says how many development cards are in the deck.  | 
 class | 
SOCDiceResult
This message reports total of what was rolled on the dice.  | 
 class | 
SOCDiceResultResources
All resources gained by players from a dice roll.  | 
 class | 
SOCDiscard
This message means that a player is discarding.  | 
 class | 
SOCDiscardRequest
This message from server to a client requests that the player discard a particular number of cards.  | 
 class | 
SOCDiscoveryPick
This message says which resources the player picked for a Discovery card  | 
 class | 
SOCEndTurn
This message means that a player wants to end the turn  | 
 class | 
SOCFirstPlayer
This message says who the first player is  | 
 class | 
SOCGameMembers
This message lists all the members of a game.  | 
 class | 
SOCGameOptionGetDefaults
Information on current defaults for new games' game options. | 
 class | 
SOCGameOptionGetInfos
This message from client sends a list of game options to the server.  | 
 class | 
SOCGameOptionInfo
Information on one available SOCGameOption game option. | 
 class | 
SOCGames
This message lists all the soc games currently on a server, without game options. | 
 class | 
SOCGameServerText
This message contains a text message or announcement from the server for a SoC game.  | 
 class | 
SOCGameState
This message communicates the current state of the game.  | 
 class | 
SOCGameStats
This message contains the scores for the people at a game.  | 
 class | 
SOCGamesWithOptions
List of all games currently on the server, including their game options. | 
 class | 
SOCGameTextMsg
This message contains a text message for a SoC game.  | 
 class | 
SOCImARobot
This message tells the server that the client is a robot.  | 
 class | 
SOCInventoryItemAction
This message is a client player request, or server response or announcement, about SOCInventoryItems in a player's inventory. | 
 class | 
SOCJoin
This message means that someone is joining a channel  | 
 class | 
SOCJoinAuth
This message means that the server has authorized this client to join a channel  | 
 class | 
SOCJoinGame
This message is used to join any existing game (with or without game options).  | 
 class | 
SOCJoinGameAuth
This message from server to a client means that the client's player is allowed to join the game.  | 
 class | 
SOCLargestArmy
This message says which player has largest army.  | 
 class | 
SOCLastSettlement
This message tells the client where the last settlement was places Used for robots during init set up  | 
 class | 
SOCLeave
This message means that someone is leaveing a channel  | 
 class | 
SOCLeaveAll
This message means that someone is leaving all the channels  | 
 class | 
SOCLeaveGame
This message means that someone is leaving a game.  | 
 class | 
SOCLegalEdges
This message contains a list of legal edges (ships or roads).  | 
 class | 
SOCLocalizedStrings
Message from server for i18n localization of item types such as game options or scenarios, such as SOCLocalizedStrings.TYPE_GAMEOPT or SOCLocalizedStrings.TYPE_SCENARIO, or request from client to get
 localized strings for specific keys of certain item types. | 
 class | 
SOCLongestRoad
This message says which player has longest road.  | 
 class | 
SOCMakeOffer
This message means that a player wants to trade with other players  | 
 class | 
SOCMembers
This message lists all the members of a chat channel  | 
 class | 
SOCMessageMulti
Message containing multiple parameters, each of which may have sub-fields.  | 
 class | 
SOCMessageTemplate0
Template for per-game message types with no parameters.  | 
 class | 
SOCMessageTemplate1i
Template for per-game message types with 1 integer parameter.  | 
 class | 
SOCMessageTemplate1s
Template for per-game message types with 1 string parameter.  | 
 class | 
SOCMessageTemplate2i
Template for per-game message types with 2 integer parameters.  | 
 class | 
SOCMessageTemplate2s
Template for per-game message types with 2 string parameters.  | 
 class | 
SOCMessageTemplate3i
Template for per-game message types with 3 integer parameters.  | 
 class | 
SOCMessageTemplate3s
Template for per-game message types with 3 string parameters.  | 
 class | 
SOCMessageTemplate4i
Template for per-game message types with 4 integer parameters.  | 
 class | 
SOCMessageTemplateJoinGame
This message means that someone is joining a game.  | 
 class | 
SOCMessageTemplateMi
Template for message types with variable number of integer parameters.  | 
 class | 
SOCMessageTemplateMs
Template for message types with variable number of string parameters.  | 
 class | 
SOCMonopolyPick
This message says what resource the current player wants to monopolize  | 
 class | 
SOCMovePiece
This server-broadcast message announces a player is moving a piece that's already on the board, to a new location.  | 
 class | 
SOCMovePieceRequest
This client-to-server message requests moving a piece that's already on the board, to a new location.  | 
 class | 
SOCMoveRobber
This message (from client to server) means that a client player wants to move the robber or pirate ship, or (from server to all players) a player has moved the robber or pirate ship.  | 
 class | 
SOCNewChannel
This message means that a new chat channel has been created.  | 
 class | 
SOCNewGame
This message to all clients means that a new game has been created.  | 
 class | 
SOCNewGameWithOptions
This broadcast message from server announces a new game, with a certain version and possibly game options, to all clients. | 
 class | 
SOCNewGameWithOptionsRequest
This message means that client wants to create a new game, with options; needs same username/password options as JOINGAME. | 
 class | 
SOCPickResources
This message from client means that the client player has picked these resources to receive from the gold hex.  | 
 class | 
SOCPickResourcesRequest
This message from server to a client informs the client's player that in a game they're playing, they must pick which resources they want from a gold hex.  | 
 class | 
SOCPieceValue
This message from server updates the value(s) of a piece on the board.  | 
 class | 
SOCPlayDevCardRequest
This message from client means that a player wants to play a development card.  | 
 class | 
SOCPlayerElement
This message conveys one part of the player's status, such as their number of settlements remaining.  | 
 class | 
SOCPlayerElements
This message from the server holds information on some parts of the player's status, such as resource type counts.  | 
 class | 
SOCPlayerStats
Statistics of one type for one player.  | 
 class | 
SOCPotentialSettlements
This message contains a list of potential settlements.  | 
 class | 
SOCPutPiece
This message means that a player is asking to place, or has placed, a piece on the board.  | 
 class | 
SOCRejectConnection
This message means that a client isn't allowed to connect  | 
 class | 
SOCRejectOffer
This message means that the player is rejecting an offer.  | 
 class | 
SOCRemovePiece
This message from server announces a SOCShip removed from the board.  | 
 class | 
SOCResetBoardAuth
This message from server informs the client that a game they're playing has been "reset" to a new game (with same name and players, new layout), and they should join at the given position.  | 
 class | 
SOCResetBoardReject
This message from server informs all clients that voting has ended, and the board reset request has been rejected.  | 
 class | 
SOCResetBoardRequest
This message from client to server requests a "reset board" of a game being played.  | 
 class | 
SOCResetBoardVote
This bi-directional message gives the client's vote on a "board reset", which was requested by another player in that game.  | 
 class | 
SOCResetBoardVoteRequest
This message from server informs the client that in a game they're playing, another player requests a "board reset" (new game with same name and players, new layout), and they should vote yes or no.  | 
 class | 
SOCResourceCount
This message has the total resource count for a player  | 
 class | 
SOCRevealFogHex
This message from server reveals a hex previously hidden by fog on the large sea board.  | 
 class | 
SOCRobotDismiss
This message means that the server wants the robot who receives this message to leave the game.  | 
 class | 
SOCRobotJoinGameRequest
This message means that the server is asking this robot client to join a game.  | 
 class | 
SOCRollDice
This message is a request from client to server; client player wants to roll the dice.  | 
 class | 
SOCRollDicePrompt
This message from server informs all players whose turn it is, so they may roll the dice, or take other action allowable at that time.  | 
 class | 
SOCRollDiceRequest
This message requests that the player rolls the dice this client to join a game  | 
 class | 
SOCScenarioInfo
A client's request for updated SOCScenario info,
 or server's reply with information on one available SOCScenario
 (including localization). | 
 class | 
SOCServerPing
This is a ping message from the server, or its reply from the client.  | 
 class | 
SOCSetPlayedDevCard
This message sets the flag which says if a player has played a development card this turn  | 
 class | 
SOCSetSeatLock
This message sets the lock state of a seat.  | 
 class | 
SOCSetSpecialItem
This message is to pick, set, or clear a SOCSpecialItem in the game and/or owning player's Special Item list. | 
 class | 
SOCSetTurn
This message from server to client says whose turn it is.  | 
 class | 
SOCSetupDone
This message means that all players are done placing their initial settlements.  | 
 class | 
SOCSimpleAction
This generic message from the server to clients handles a simple action or event for a client player in a game.  | 
 class | 
SOCSimpleRequest
This generic message handles a simple request from a client player in a game.  | 
 class | 
SOCSitDown
This message means that a player wants to sit down to play.  | 
 class | 
SOCStartGame
From client, this message means that a player wants to start the game; from server, it means that a game has just started, leaving state NEW. | 
 class | 
SOCStatusMessage
This is a text message that shows in a status box on the client.  | 
 class | 
SOCSVPTextMessage
Message from server to game's clients, with the number of Special Victory Points (SVP) and reason the player was awarded them.  | 
 class | 
SOCTextMsg
This message contains a text message  | 
 class | 
SOCTimingPing
This message contains a timing ping sent by the server to each robot, once each second.  | 
 class | 
SOCTurn
This message from server to client signals end of the current player's turn.  | 
 class | 
SOCUpdateRobotParams
This message means that the robot client needs to update the robot parameters with the contained information  | 
 class | 
SOCVersion
This message sends the server's version and features, or client's version and locale, to the other side of the connection.  | 
| Methods in soc.message that return SOCMessage | |
|---|---|
static SOCMessage | 
SOCMessage.toMsg(java.lang.String s)
Convert a string into a SOCMessage.  | 
| Uses of SOCMessage in soc.robot | 
|---|
| Fields in soc.robot with type parameters of type SOCMessage | |
|---|---|
private  java.util.Hashtable<java.lang.String,CappedQueue<SOCMessage>> | 
SOCRobotClient.brainQs
the message queues for the different brains  | 
private  java.util.Vector<SOCMessage> | 
SOCRobotClient.debugRandomPauseQueue
When SOCRobotClient.debugRandomPauseActive is true, store incoming messages
 from the server into this queue until SOCRobotClient.debugRandomPauseUntil. | 
protected  CappedQueue<SOCMessage> | 
SOCRobotBrain.gameEventQ
The queue of game messages; contents are SOCMessage. | 
(package private)  CappedQueue<SOCMessage> | 
SOCRobotPinger.messageQueue
 | 
private  java.util.Vector<SOCMessage> | 
SOCRobotBrain.turnEventsCurrent
The game messages received this turn / previous turn, for debugging.  | 
private  java.util.Vector<SOCMessage> | 
SOCRobotBrain.turnEventsPrev
The game messages received this turn / previous turn, for debugging.  | 
| Methods in soc.robot with parameters of type SOCMessage | |
|---|---|
 void | 
SOCRobotClient.treat(SOCMessage mes)
Treat the incoming messages.  | 
| Constructor parameters in soc.robot with type arguments of type SOCMessage | |
|---|---|
SOCRobotBrain(SOCRobotClient rc,
              SOCRobotParameters params,
              SOCGame ga,
              CappedQueue<SOCMessage> mq)
Create a robot brain to play a game.  | 
|
SOCRobotPinger(CappedQueue<SOCMessage> q,
               java.lang.String gameName,
               java.lang.String nickname)
Create a robot pinger  | 
|
| Uses of SOCMessage in soc.server | 
|---|
| Methods in soc.server that return SOCMessage | |
|---|---|
private  SOCMessage | 
SOCGameHandler.getBoardLayoutMessage(SOCGame ga)
Put together the board layout message for this game.  | 
| Methods in soc.server with parameters of type SOCMessage | |
|---|---|
 void | 
SOCServer.messageToChannel(java.lang.String ch,
                 SOCMessage mes)
Send a message to the given channel  | 
 void | 
SOCServer.messageToChannelWithMon(java.lang.String ch,
                        SOCMessage mes)
Send a message to the given channel WARNING: MUST HAVE THE gameList.takeMonitorForChannel(ch) before calling this method  | 
 void | 
SOCServer.messageToGame(java.lang.String ga,
              SOCMessage mes)
Send a message to the given game.  | 
 void | 
SOCServer.messageToGameExcept(java.lang.String gn,
                    StringConnection ex,
                    SOCMessage mes,
                    boolean takeMon)
Send a message to all the connections in a game excluding one.  | 
 void | 
SOCServer.messageToGameExcept(java.lang.String gn,
                    java.util.Vector<StringConnection> ex,
                    SOCMessage mes,
                    boolean takeMon)
Send a message to all the connections in a game excluding some.  | 
 void | 
SOCServer.messageToGameForVersions(SOCGame ga,
                         int vmin,
                         int vmax,
                         SOCMessage mes,
                         boolean takeMon)
Send a message to all the connections in a game in a certain version range.  | 
 void | 
SOCServer.messageToGameForVersionsExcept(SOCGame ga,
                               int vmin,
                               int vmax,
                               StringConnection ex,
                               SOCMessage mes,
                               boolean takeMon)
Send a message to all the connections in a game in a certain version range, excluding one.  | 
 void | 
SOCServer.messageToGameWithMon(java.lang.String ga,
                     SOCMessage mes)
Send a message to the given game.  | 
 void | 
SOCServer.messageToPlayer(StringConnection c,
                SOCMessage mes)
Send a message to a player and record it  | 
  | 
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||