Uses of Package
soc.message

Packages that use soc.message
soc.client   
soc.message   
soc.robot   
soc.server   
 

Classes in soc.message used by soc.client
SOCBCastTextMsg
          This message contains a text message for everyone connected
SOCBoardLayout
          This message contains the board layout information.
SOCBoardLayout2
          This message contains the board's layout information and its encoding version.
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.
SOCCancelBuildRequest
          This message type has five possible meanings, depending on game state and direction sent:
SOCChangeFace
          This message says that a player is changing the face icon.
SOCChannels
          This message lists all the chat channels on a server.
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.
SOCChoosePlayerRequest
          This message from server to client asks a player to choose a player to steal from.
SOCClearOffer
          This message means that the player is retracting an offer.
SOCClearTradeMsg
          This message means that the server wants the trade message cleared.
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.
SOCDeleteChannel
          This message means that a chat channel has been destroyed.
SOCDeleteGame
          This message means that a soc game has been destroyed.
SOCDevCardAction
          This message from the server means that a player is drawing or playing a development card; response to SOCPlayDevCardRequest.
SOCDevCardCount
          This message says how many development cards are in the deck.
SOCDiceResult
          This message reports total of what was rolled on the dice.
SOCDiceResultResources
          All resources gained by players from a dice roll.
SOCDiscardRequest
          This message from server to a client requests that the player discard a particular number of cards.
SOCFirstPlayer
          This message says who the first player is
SOCGameMembers
          This message lists all the members of a game.
SOCGameOptionGetDefaults
          Information on current defaults for new games' game options.
SOCGameOptionInfo
          Information on one available SOCGameOption game option.
SOCGames
          This message lists all the soc games currently on a server, without game options.
SOCGameServerText
          This message contains a text message or announcement from the server for a SoC game.
SOCGameState
          This message communicates the current state of the game.
SOCGameStats
          This message contains the scores for the people at a game.
SOCGamesWithOptions
          List of all games currently on the server, including their game options.
SOCGameTextMsg
          This message contains a text message for a SoC game.
SOCInventoryItemAction
          This message is a client player request, or server response or announcement, about SOCInventoryItems in a player's inventory.
SOCJoin
          This message means that someone is joining a channel
SOCJoinAuth
          This message means that the server has authorized this client to join a channel
SOCJoinGame
          This message is used to join any existing game (with or without game options).
SOCJoinGameAuth
          This message from server to a client means that the client's player is allowed to join the game.
SOCLargestArmy
          This message says which player has largest army.
SOCLeave
          This message means that someone is leaveing a channel
SOCLeaveGame
          This message means that someone is leaving a game.
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.
SOCLongestRoad
          This message says which player has longest road.
SOCMakeOffer
          This message means that a player wants to trade with other players
SOCMembers
          This message lists all the members of a chat channel
SOCMessage
          Messages used for game data, events, and chatting on a channel.
SOCMovePiece
          This server-broadcast message announces a player is moving a piece that's already on the board, to a new location.
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.
SOCNewChannel
          This message means that a new chat channel has been created.
SOCNewGame
          This message to all clients means that a new game has been created.
SOCNewGameWithOptions
          This broadcast message from server announces a new game, with a certain version and possibly game options, to all clients.
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.
SOCPieceValue
          This message from server updates the value(s) of a piece on the board.
SOCPlayerElement
          This message conveys one part of the player's status, such as their number of settlements remaining.
SOCPlayerStats
          Statistics of one type for one player.
SOCPotentialSettlements
          This message contains a list of potential settlements.
SOCPutPiece
          This message means that a player is asking to place, or has placed, a piece on the board.
SOCRejectConnection
          This message means that a client isn't allowed to connect
SOCRejectOffer
          This message means that the player is rejecting an offer.
SOCRemovePiece
          This message from server announces a SOCShip removed from the board.
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.
SOCResetBoardReject
          This message from server informs all clients that voting has ended, and the board reset request has been rejected.
SOCResetBoardVote
          This bi-directional message gives the client's vote on a "board reset", which was requested by another player in that game.
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.
SOCResourceCount
          This message has the total resource count for a player
SOCRevealFogHex
          This message from server reveals a hex previously hidden by fog on the large sea board.
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.
SOCScenarioInfo
          A client's request for updated SOCScenario info, or server's reply with information on one available SOCScenario (including localization).
SOCServerPing
          This is a ping message from the server, or its reply from the client.
SOCSetPlayedDevCard
          This message sets the flag which says if a player has played a development card this turn
SOCSetSeatLock
          This message sets the lock state of a seat.
SOCSetSpecialItem
          This message is to pick, set, or clear a SOCSpecialItem in the game and/or owning player's Special Item list.
SOCSetTurn
          This message from server to client says whose turn it is.
SOCSimpleAction
          This generic message from the server to clients handles a simple action or event for a client player in a game.
SOCSimpleRequest
          This generic message handles a simple request from a client player in a game.
SOCSitDown
          This message means that a player wants to sit down to play.
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.
SOCStatusMessage
          This is a text message that shows in a status box on the client.
SOCSVPTextMessage
          Message from server to game's clients, with the number of Special Victory Points (SVP) and reason the player was awarded them.
SOCTextMsg
          This message contains a text message
SOCTurn
          This message from server to client signals end of the current player's turn.
SOCVersion
          This message sends the server's version and features, or client's version and locale, to the other side of the connection.
 

Classes in soc.message used by soc.message
SOCAcceptOffer
          This message means that the player is accepting an offer.
SOCAdminPing
          This message is a way for the admin to test if a robot is connected and running
SOCAdminReset
          This message allows the admin to reset a robot player remotely
SOCAuthRequest
          Authentication request, to connect and check password without creating or joining a game or channel.
SOCBankTrade
          This message means that a player wants to trade with the bank or a port.
SOCBCastTextMsg
          This message contains a text message for everyone connected
SOCBoardLayout
          This message contains the board layout information.
SOCBoardLayout2
          This message contains the board's layout information and its encoding version.
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.
SOCBuildRequest
          This message, from client to server, says which piece type the current player wants to build.
SOCBuyCardRequest
          This message means that the player wants to buy a development card.
SOCCancelBuildRequest
          This message type has five possible meanings, depending on game state and direction sent:
SOCChangeFace
          This message says that a player is changing the face icon.
SOCChannels
          This message lists all the chat channels on a server.
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.
SOCChoosePlayerRequest
          This message from server to client asks a player to choose a player to steal from.
SOCClearOffer
          This message means that the player is retracting an offer.
SOCClearTradeMsg
          This message means that the server wants the trade message cleared.
SOCCreateAccount
          This message is a request to create an account
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.
SOCDeleteChannel
          This message means that a chat channel has been destroyed.
SOCDeleteGame
          This message means that a soc game has been destroyed.
SOCDevCardAction
          This message from the server means that a player is drawing or playing a development card; response to SOCPlayDevCardRequest.
SOCDevCardCount
          This message says how many development cards are in the deck.
SOCDiceResult
          This message reports total of what was rolled on the dice.
SOCDiceResultResources
          All resources gained by players from a dice roll.
SOCDiscard
          This message means that a player is discarding.
SOCDiscardRequest
          This message from server to a client requests that the player discard a particular number of cards.
SOCDiscoveryPick
          This message says which resources the player picked for a Discovery card
SOCEndTurn
          This message means that a player wants to end the turn
SOCFirstPlayer
          This message says who the first player is
SOCGameMembers
          This message lists all the members of a game.
SOCGameOptionGetDefaults
          Information on current defaults for new games' game options.
SOCGameOptionGetInfos
          This message from client sends a list of game options to the server.
SOCGameOptionInfo
          Information on one available SOCGameOption game option.
SOCGames
          This message lists all the soc games currently on a server, without game options.
SOCGameServerText
          This message contains a text message or announcement from the server for a SoC game.
SOCGameState
          This message communicates the current state of the game.
SOCGameStats
          This message contains the scores for the people at a game.
SOCGamesWithOptions
          List of all games currently on the server, including their game options.
SOCGameTextMsg
          This message contains a text message for a SoC game.
SOCImARobot
          This message tells the server that the client is a robot.
SOCInventoryItemAction
          This message is a client player request, or server response or announcement, about SOCInventoryItems in a player's inventory.
SOCJoin
          This message means that someone is joining a channel
SOCJoinAuth
          This message means that the server has authorized this client to join a channel
SOCJoinGame
          This message is used to join any existing game (with or without game options).
SOCJoinGameAuth
          This message from server to a client means that the client's player is allowed to join the game.
SOCKeyedMessage
          This indicates that a SOCMessage type contains a keyed text field which needs to be localized while sending to clients.
SOCLargestArmy
          This message says which player has largest army.
SOCLastSettlement
          This message tells the client where the last settlement was places Used for robots during init set up
SOCLeave
          This message means that someone is leaveing a channel
SOCLeaveAll
          This message means that someone is leaving all the channels
SOCLeaveGame
          This message means that someone is leaving a game.
SOCLegalEdges
          This message contains a list of legal edges (ships or roads).
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.
SOCLongestRoad
          This message says which player has longest road.
SOCMakeOffer
          This message means that a player wants to trade with other players
SOCMembers
          This message lists all the members of a chat channel
SOCMessage
          Messages used for game data, events, and chatting on a channel.
SOCMessageForGame
          This indicates that a SOCMessage type is always about a particular game named in the message, or never about that game.
SOCMessageMulti
          Message containing multiple parameters, each of which may have sub-fields.
SOCMessageTemplate0
          Template for per-game message types with no parameters.
SOCMessageTemplate1i
          Template for per-game message types with 1 integer parameter.
SOCMessageTemplate2i
          Template for per-game message types with 2 integer parameters.
SOCMessageTemplate2s
          Template for per-game message types with 2 string parameters.
SOCMessageTemplate3i
          Template for per-game message types with 3 integer parameters.
SOCMessageTemplate4i
          Template for per-game message types with 4 integer parameters.
SOCMessageTemplateJoinGame
          This message means that someone is joining a game.
SOCMessageTemplateMi
          Template for message types with variable number of integer parameters.
SOCMessageTemplateMs
          Template for message types with variable number of string parameters.
SOCMonopolyPick
          This message says what resource the current player wants to monopolize
SOCMovePiece
          This server-broadcast message announces a player is moving a piece that's already on the board, to a new location.
SOCMovePieceRequest
          This client-to-server message requests moving a piece that's already on the board, to a new location.
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.
SOCNewChannel
          This message means that a new chat channel has been created.
SOCNewGame
          This message to all clients means that a new game has been created.
SOCNewGameWithOptions
          This broadcast message from server announces a new game, with a certain version and possibly game options, to all clients.
SOCNewGameWithOptionsRequest
          This message means that client wants to create a new game, with options; needs same username/password options as JOINGAME.
SOCPickResources
          This message from client means that the client player has picked these resources to receive from the gold hex.
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.
SOCPieceValue
          This message from server updates the value(s) of a piece on the board.
SOCPlayDevCardRequest
          This message from client means that a player wants to play a development card.
SOCPlayerElement
          This message conveys one part of the player's status, such as their number of settlements remaining.
SOCPlayerElements
          This message from the server holds information on some parts of the player's status, such as resource type counts.
SOCPlayerStats
          Statistics of one type for one player.
SOCPotentialSettlements
          This message contains a list of potential settlements.
SOCPutPiece
          This message means that a player is asking to place, or has placed, a piece on the board.
SOCRejectConnection
          This message means that a client isn't allowed to connect
SOCRejectOffer
          This message means that the player is rejecting an offer.
SOCRemovePiece
          This message from server announces a SOCShip removed from the board.
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.
SOCResetBoardReject
          This message from server informs all clients that voting has ended, and the board reset request has been rejected.
SOCResetBoardRequest
          This message from client to server requests a "reset board" of a game being played.
SOCResetBoardVote
          This bi-directional message gives the client's vote on a "board reset", which was requested by another player in that game.
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.
SOCResourceCount
          This message has the total resource count for a player
SOCRevealFogHex
          This message from server reveals a hex previously hidden by fog on the large sea board.
SOCRobotDismiss
          This message means that the server wants the robot who receives this message to leave the game.
SOCRobotJoinGameRequest
          This message means that the server is asking this robot client to join a game.
SOCRollDice
          This message is a request from client to server; client player wants to roll the dice.
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.
SOCRollDiceRequest
          This message requests that the player rolls the dice this client to join a game
SOCScenarioInfo
          A client's request for updated SOCScenario info, or server's reply with information on one available SOCScenario (including localization).
SOCServerPing
          This is a ping message from the server, or its reply from the client.
SOCSetPlayedDevCard
          This message sets the flag which says if a player has played a development card this turn
SOCSetSeatLock
          This message sets the lock state of a seat.
SOCSetSpecialItem
          This message is to pick, set, or clear a SOCSpecialItem in the game and/or owning player's Special Item list.
SOCSetTurn
          This message from server to client says whose turn it is.
SOCSetupDone
          This message means that all players are done placing their initial settlements.
SOCSimpleAction
          This generic message from the server to clients handles a simple action or event for a client player in a game.
SOCSimpleRequest
          This generic message handles a simple request from a client player in a game.
SOCSitDown
          This message means that a player wants to sit down to play.
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.
SOCStatusMessage
          This is a text message that shows in a status box on the client.
SOCSVPTextMessage
          Message from server to game's clients, with the number of Special Victory Points (SVP) and reason the player was awarded them.
SOCTextMsg
          This message contains a text message
SOCTimingPing
          This message contains a timing ping sent by the server to each robot, once each second.
SOCTurn
          This message from server to client signals end of the current player's turn.
SOCUpdateRobotParams
          This message means that the robot client needs to update the robot parameters with the contained information
SOCVersion
          This message sends the server's version and features, or client's version and locale, to the other side of the connection.
 

Classes in soc.message used by soc.robot
SOCAdminPing
          This message is a way for the admin to test if a robot is connected and running
SOCAdminReset
          This message allows the admin to reset a robot player remotely
SOCCancelBuildRequest
          This message type has five possible meanings, depending on game state and direction sent:
SOCChangeFace
          This message says that a player is changing the face icon.
SOCClearTradeMsg
          This message means that the server wants the trade message cleared.
SOCDeleteGame
          This message means that a soc game has been destroyed.
SOCDevCardAction
          This message from the server means that a player is drawing or playing a development card; response to SOCPlayDevCardRequest.
SOCGameMembers
          This message lists all the members of a game.
SOCGameState
          This message communicates the current state of the game.
SOCGameTextMsg
          This message contains a text message for a SoC game.
SOCJoinGame
          This message is used to join any existing game (with or without game options).
SOCJoinGameAuth
          This message from server to a client means that the client's player is allowed to join the game.
SOCLargestArmy
          This message says which player has largest army.
SOCLongestRoad
          This message says which player has longest road.
SOCMakeOffer
          This message means that a player wants to trade with other players
SOCMessage
          Messages used for game data, events, and chatting on a channel.
SOCMessageForGame
          This indicates that a SOCMessage type is always about a particular game named in the message, or never about that game.
SOCPlayerElement
          This message conveys one part of the player's status, such as their number of settlements remaining.
SOCPutPiece
          This message means that a player is asking to place, or has placed, a piece on the board.
SOCRejectOffer
          This message means that the player is rejecting an offer.
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.
SOCRobotDismiss
          This message means that the server wants the robot who receives this message to leave the game.
SOCRobotJoinGameRequest
          This message means that the server is asking this robot client to join a game.
SOCServerPing
          This is a ping message from the server, or its reply from the client.
SOCSitDown
          This message means that a player wants to sit down to play.
SOCStatusMessage
          This is a text message that shows in a status box on the client.
SOCTimingPing
          This message contains a timing ping sent by the server to each robot, once each second.
SOCUpdateRobotParams
          This message means that the robot client needs to update the robot parameters with the contained information
 

Classes in soc.message used by soc.server
SOCAcceptOffer
          This message means that the player is accepting an offer.
SOCAuthRequest
          Authentication request, to connect and check password without creating or joining a game or channel.
SOCBankTrade
          This message means that a player wants to trade with the bank or a port.
SOCBuildRequest
          This message, from client to server, says which piece type the current player wants to build.
SOCBuyCardRequest
          This message means that the player wants to buy a development card.
SOCCancelBuildRequest
          This message type has five possible meanings, depending on game state and direction sent:
SOCChangeFace
          This message says that a player is changing the face icon.
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.
SOCClearOffer
          This message means that the player is retracting an offer.
SOCCreateAccount
          This message is a request to create an account
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.
SOCDiscard
          This message means that a player is discarding.
SOCDiscoveryPick
          This message says which resources the player picked for a Discovery card
SOCEndTurn
          This message means that a player wants to end the turn
SOCGameOptionGetDefaults
          Information on current defaults for new games' game options.
SOCGameOptionGetInfos
          This message from client sends a list of game options to the server.
SOCGameTextMsg
          This message contains a text message for a SoC game.
SOCImARobot
          This message tells the server that the client is a robot.
SOCInventoryItemAction
          This message is a client player request, or server response or announcement, about SOCInventoryItems in a player's inventory.
SOCJoin
          This message means that someone is joining a channel
SOCJoinGame
          This message is used to join any existing game (with or without game options).
SOCKeyedMessage
          This indicates that a SOCMessage type contains a keyed text field which needs to be localized while sending to clients.
SOCLeave
          This message means that someone is leaveing a channel
SOCLeaveGame
          This message means that someone is leaving a game.
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.
SOCMakeOffer
          This message means that a player wants to trade with other players
SOCMessage
          Messages used for game data, events, and chatting on a channel.
SOCMessageForGame
          This indicates that a SOCMessage type is always about a particular game named in the message, or never about that game.
SOCMonopolyPick
          This message says what resource the current player wants to monopolize
SOCMovePieceRequest
          This client-to-server message requests moving a piece that's already on the board, to a new location.
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.
SOCNewGameWithOptionsRequest
          This message means that client wants to create a new game, with options; needs same username/password options as JOINGAME.
SOCPickResources
          This message from client means that the client player has picked these resources to receive from the gold hex.
SOCPlayDevCardRequest
          This message from client means that a player wants to play a development card.
SOCPutPiece
          This message means that a player is asking to place, or has placed, a piece on the board.
SOCRejectOffer
          This message means that the player is rejecting an offer.
SOCResetBoardRequest
          This message from client to server requests a "reset board" of a game being played.
SOCResetBoardVote
          This bi-directional message gives the client's vote on a "board reset", which was requested by another player in that game.
SOCRollDice
          This message is a request from client to server; client player wants to roll the dice.
SOCScenarioInfo
          A client's request for updated SOCScenario info, or server's reply with information on one available SOCScenario (including localization).
SOCServerPing
          This is a ping message from the server, or its reply from the client.
SOCSetSeatLock
          This message sets the lock state of a seat.
SOCSetSpecialItem
          This message is to pick, set, or clear a SOCSpecialItem in the game and/or owning player's Special Item list.
SOCSimpleRequest
          This generic message handles a simple request from a client player in a game.
SOCSitDown
          This message means that a player wants to sit down to play.
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.
SOCVersion
          This message sends the server's version and features, or client's version and locale, to the other side of the connection.