com.heroiclabs.nakama

Interface SocketClient

All Known Implementing Classes:

WebSocketClient

public interface SocketClient

A socket connection to the server.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	acceptParty(@NonNull java.lang.String partyId, UserPresence userPresence) Accept a member to a party.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker() Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker(int minCount) Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker(int minCount, int maxCount) Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker(int minCount, int maxCount, java.lang.String query) Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker(int minCount, int maxCount, java.lang.String query, java.util.Map<java.lang.String,java.lang.String> stringProperties) Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket>	addMatchmaker(int minCount, int maxCount, java.lang.String query, java.util.Map<java.lang.String,java.lang.String> stringProperties, java.util.Map<java.lang.String,java.lang.Double> numericProperties) Join the matchmaker pool and search for opponents on the server.
com.google.common.util.concurrent.ListenableFuture<PartyMatchmakerTicket>	addPartyMatchmaker(@NonNull java.lang.String partyId, int minCount, int maxCount, @NonNull java.lang.String query, java.util.Map<java.lang.String,java.lang.String> stringProperties, java.util.Map<java.lang.String,java.lang.Double> numericProperties, int countMultiple) Begin matchmaking as a party.
com.google.common.util.concurrent.ListenableFuture<Party>	closeParty(@NonNull java.lang.String partyId) End a party.
com.google.common.util.concurrent.ListenableFuture<Session>	connect(@NonNull Session session, @NonNull SocketListener listener) Connect to the server.
com.google.common.util.concurrent.ListenableFuture<Session>	connect(@NonNull Session session, @NonNull SocketListener listener, boolean createStatus) Connect to the server.
com.google.common.util.concurrent.ListenableFuture<Match>	createMatch() Create a multiplayer match on the server.
com.google.common.util.concurrent.ListenableFuture<Party>	createParty(boolean open, int maxSize) Create a party.
com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean>	disconnect() Close the connection with the server.
com.google.common.util.concurrent.ListenableFuture<Status>	followUsers(java.util.List<java.lang.String> userIds, java.lang.String... usernames) Follow one or more users for status updates.
com.google.common.util.concurrent.ListenableFuture<Status>	followUsers(java.lang.String... userIds) Follow one or more users for status updates.
com.google.common.util.concurrent.ListenableFuture<Channel>	joinChat(@NonNull java.lang.String target, @NonNull ChannelType type) Join a chat channel on the server.
com.google.common.util.concurrent.ListenableFuture<Channel>	joinChat(@NonNull java.lang.String target, @NonNull ChannelType type, boolean persistence) Join a chat channel on the server.
com.google.common.util.concurrent.ListenableFuture<Channel>	joinChat(@NonNull java.lang.String target, @NonNull ChannelType type, boolean persistence, boolean hidden) Join a chat channel on the server.
com.google.common.util.concurrent.ListenableFuture<Match>	joinMatch(@NonNull java.lang.String matchId) Join a multiplayer match by ID.
com.google.common.util.concurrent.ListenableFuture<Match>	joinMatch(@NonNull java.lang.String matchId, @NonNull java.util.Map<java.lang.String,java.lang.String> metadata) Join a multiplayer match by ID.
com.google.common.util.concurrent.ListenableFuture<Match>	joinMatchToken(@NonNull java.lang.String token) Join a multiplayer match with a matchmaker.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	joinParty(@NonNull java.lang.String partyId) Join a party.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	leaveChat(@NonNull java.lang.String channelId) Leave a chat channel on the server.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	leaveMatch(@NonNull java.lang.String matchId) Leave a match on the server.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	leaveParty(@NonNull java.lang.String partyId) Leave a party.
com.google.common.util.concurrent.ListenableFuture<PartyJoinRequest>	listPartyJoinRequest(@NonNull java.lang.String partyId) Lists pending join requests for a party.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	promoteParty(@NonNull java.lang.String partyId, UserPresence userPresence) Promote a member to party leader.
com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck>	removeChatMessage(@NonNull java.lang.String channelId, @NonNull java.lang.String messageId) Remove a chat message from a channel on the server.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	removeMatchmaker(@NonNull java.lang.String ticket) Leave the matchmaker pool by ticket.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	removeParty(@NonNull java.lang.String partyId, UserPresence userPresence) Remove/reject a member from a party.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	removePartyMatchmaker(@NonNull java.lang.String partyId, @NonNull java.lang.String ticket) Cancel a party matchmaking process using a ticket.
com.google.common.util.concurrent.ListenableFuture<Rpc>	rpc(@NonNull java.lang.String id) Send an RPC message to the server.
com.google.common.util.concurrent.ListenableFuture<Rpc>	rpc(@NonNull java.lang.String id, java.lang.String payload) Send an RPC message to the server.
void	sendMatchData(@NonNull java.lang.String matchId, long opCode, @NonNull byte[] data) Send a state change to a match on the server.
void	sendMatchData(@NonNull java.lang.String matchId, long opCode, @NonNull byte[] data, UserPresence... presences) Send a state change to a match on the server.
void	sendPartyData(@NonNull java.lang.String partyId, int opCode, @NonNull byte[] data) Send party data.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	unfollowUsers(java.lang.String... userIds) Unfollow status updates for one or more users.
com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck>	updateChatMessage(@NonNull java.lang.String channelId, @NonNull java.lang.String messageId, @NonNull java.lang.String content) Update a chat message to a channel on the server.
com.google.common.util.concurrent.ListenableFuture<java.lang.Void>	updateStatus(java.lang.String status) Update the user's status online.
com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck>	writeChatMessage(@NonNull java.lang.String channelId, @NonNull java.lang.String content) Send a chat message to a channel on the server.

Method Detail

connect

com.google.common.util.concurrent.ListenableFuture<Session> connect(@NonNull
                                                                    @NonNull Session session,
                                                                    @NonNull
                                                                    @NonNull SocketListener listener)

Connect to the server.

Parameters:

session - The session of the user.

listener - An event listener to notify on updates.

Returns:

A future.

connect

com.google.common.util.concurrent.ListenableFuture<Session> connect(@NonNull
                                                                    @NonNull Session session,
                                                                    @NonNull
                                                                    @NonNull SocketListener listener,
                                                                    boolean createStatus)

Connect to the server.

Parameters:

session - The session of the user.

listener - An event listener to notify on updates.

createStatus - True if the socket should show the user as online to others.

Returns:

A future.

disconnect

com.google.common.util.concurrent.ListenableFuture<java.lang.Boolean> disconnect()

Close the connection with the server.

Returns:

A close future.

joinChat

com.google.common.util.concurrent.ListenableFuture<Channel> joinChat(@NonNull
                                                                     @NonNull java.lang.String target,
                                                                     @NonNull
                                                                     @NonNull ChannelType type)

Join a chat channel on the server.

Parameters:

target - The target channel to join.

type - The type of channel to join.

Returns:

A future which resolves to a Channel response.

joinChat

com.google.common.util.concurrent.ListenableFuture<Channel> joinChat(@NonNull
                                                                     @NonNull java.lang.String target,
                                                                     @NonNull
                                                                     @NonNull ChannelType type,
                                                                     boolean persistence)

Join a chat channel on the server.

Parameters:

target - The target channel to join.

type - The type of channel to join.

persistence - True if chat messages should be stored.

Returns:

A future which resolves to a Channel response.

joinChat

com.google.common.util.concurrent.ListenableFuture<Channel> joinChat(@NonNull
                                                                     @NonNull java.lang.String target,
                                                                     @NonNull
                                                                     @NonNull ChannelType type,
                                                                     boolean persistence,
                                                                     boolean hidden)

Join a chat channel on the server.

Parameters:

target - The target channel to join.

type - The type of channel to join.

persistence - True if chat messages should be stored.

hidden - True if the user should be hidden on the channel.

Returns:

A future which resolves to a Channel response.

leaveChat

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> leaveChat(@NonNull
                                                                             @NonNull java.lang.String channelId)

Leave a chat channel on the server.

Parameters:

channelId - The channel to leave.

Returns:

A future.

removeChatMessage

com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck> removeChatMessage(@NonNull
                                                                                        @NonNull java.lang.String channelId,
                                                                                        @NonNull
                                                                                        @NonNull java.lang.String messageId)

Remove a chat message from a channel on the server.

Parameters:

channelId - The chat channel with the message.

messageId - The ID of a chat message to update.

Returns:

A future.

writeChatMessage

com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck> writeChatMessage(@NonNull
                                                                                       @NonNull java.lang.String channelId,
                                                                                       @NonNull
                                                                                       @NonNull java.lang.String content)

Send a chat message to a channel on the server.

Parameters:

channelId - The channel to send on.

content - The content of the chat message.

Returns:

A future which resolves to a Channel Ack response.

updateChatMessage

com.google.common.util.concurrent.ListenableFuture<ChannelMessageAck> updateChatMessage(@NonNull
                                                                                        @NonNull java.lang.String channelId,
                                                                                        @NonNull
                                                                                        @NonNull java.lang.String messageId,
                                                                                        @NonNull
                                                                                        @NonNull java.lang.String content)

Update a chat message to a channel on the server.

Parameters:

channelId - The ID of the chat channel with the message.

messageId - The ID of the message to update.

content - The content update for the message.

Returns:

A future.

createMatch

com.google.common.util.concurrent.ListenableFuture<Match> createMatch()

Create a multiplayer match on the server.

Returns:

A future.

joinMatch

com.google.common.util.concurrent.ListenableFuture<Match> joinMatch(@NonNull
                                                                    @NonNull java.lang.String matchId)

Join a multiplayer match by ID.

Parameters:

matchId - A match ID.

Returns:

A future which resolves to the match joined.

joinMatch

com.google.common.util.concurrent.ListenableFuture<Match> joinMatch(@NonNull
                                                                    @NonNull java.lang.String matchId,
                                                                    @NonNull
                                                                    @NonNull java.util.Map<java.lang.String,java.lang.String> metadata)

Join a multiplayer match by ID.

Parameters:

matchId - A match ID.

metadata - An optional set of key-value metadata pairs to be passed to the match handler, if any.

Returns:

A future which resolves to the match joined.

joinMatchToken

com.google.common.util.concurrent.ListenableFuture<Match> joinMatchToken(@NonNull
                                                                         @NonNull java.lang.String token)

Join a multiplayer match with a matchmaker.

Parameters:

token - A matchmaker ticket result object.

Returns:

A future which resolves to the match joined.

leaveMatch

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> leaveMatch(@NonNull
                                                                              @NonNull java.lang.String matchId)

Leave a match on the server.

Parameters:

matchId - The match to leave.

Returns:

A future.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker()

Join the matchmaker pool and search for opponents on the server.

Returns:

A future which resolves to a matchmaker ticket object.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker(int minCount)

Join the matchmaker pool and search for opponents on the server.

Parameters:

minCount - The minimum number of players to compete against.

Returns:

A future which resolves to a matchmaker ticket object.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker(int minCount,
                                                                                   int maxCount)

Join the matchmaker pool and search for opponents on the server.

Parameters:

minCount - The minimum number of players to compete against.

maxCount - The maximum number of players to compete against.

Returns:

A future which resolves to a matchmaker ticket object.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker(int minCount,
                                                                                   int maxCount,
                                                                                   java.lang.String query)

Join the matchmaker pool and search for opponents on the server.

Parameters:

query - A matchmaker query to search for opponents.

minCount - The minimum number of players to compete against.

maxCount - The maximum number of players to compete against.

Returns:

A future which resolves to a matchmaker ticket object.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker(int minCount,
                                                                                   int maxCount,
                                                                                   java.lang.String query,
                                                                                   java.util.Map<java.lang.String,java.lang.String> stringProperties)

Join the matchmaker pool and search for opponents on the server.

Parameters:

query - A matchmaker query to search for opponents.

minCount - The minimum number of players to compete against.

maxCount - The maximum number of players to compete against.

stringProperties - A set of k/v properties to provide in searches.

Returns:

A future which resolves to a matchmaker ticket object.

addMatchmaker

com.google.common.util.concurrent.ListenableFuture<MatchmakerTicket> addMatchmaker(int minCount,
                                                                                   int maxCount,
                                                                                   java.lang.String query,
                                                                                   java.util.Map<java.lang.String,java.lang.String> stringProperties,
                                                                                   java.util.Map<java.lang.String,java.lang.Double> numericProperties)

Join the matchmaker pool and search for opponents on the server.

Parameters:

query - A matchmaker query to search for opponents.

minCount - The minimum number of players to compete against.

maxCount - The maximum number of players to compete against.

stringProperties - A set of k/v properties to provide in searches.

numericProperties - A set of k/v numeric properties to provide in searches.

Returns:

A future which resolves to a matchmaker ticket object.

removeMatchmaker

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> removeMatchmaker(@NonNull
                                                                                    @NonNull java.lang.String ticket)

Leave the matchmaker pool by ticket.

Parameters:

ticket - The ticket returned by the matchmaker on join. See IMatchmakerTicket.Ticket.

Returns:

A future.

sendMatchData

void sendMatchData(@NonNull
                   @NonNull java.lang.String matchId,
                   long opCode,
                   @NonNull
                   @NonNull byte[] data)

Send a state change to a match on the server. When no presences are supplied the new match state will be sent to all presences.

Parameters:

matchId - The Id of the match.

opCode - An operation code for the match state.

data - The new state to send to the match.

sendMatchData

void sendMatchData(@NonNull
                   @NonNull java.lang.String matchId,
                   long opCode,
                   @NonNull
                   @NonNull byte[] data,
                   UserPresence... presences)

Send a state change to a match on the server. When no presences are supplied the new match state will be sent to all presences.

Parameters:

matchId - The Id of the match.

opCode - An operation code for the match state.

data - The new state to send to the match.

presences - The presences in the match to send the state.

rpc

com.google.common.util.concurrent.ListenableFuture<Rpc> rpc(@NonNull
                                                            @NonNull java.lang.String id)

Send an RPC message to the server.

Parameters:

id - The ID of the function to execute.

Returns:

A future which resolves to an RPC response.

rpc

com.google.common.util.concurrent.ListenableFuture<Rpc> rpc(@NonNull
                                                            @NonNull java.lang.String id,
                                                            java.lang.String payload)

Send an RPC message to the server.

Parameters:

id - The ID of the function to execute.

payload - The string content to send to the server.

Returns:

A future which resolves to an RPC response.

followUsers

com.google.common.util.concurrent.ListenableFuture<Status> followUsers(@NonNull
                                                                       java.lang.String... userIds)

Follow one or more users for status updates.

Parameters:

userIds - The user Ids to follow.

Returns:

A future.

followUsers

com.google.common.util.concurrent.ListenableFuture<Status> followUsers(java.util.List<java.lang.String> userIds,
                                                                       java.lang.String... usernames)

Follow one or more users for status updates.

Parameters:

userIds - The user Ids to follow.

usernames - Usernames to follow.

Returns:

A future.

unfollowUsers

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> unfollowUsers(@NonNull
                                                                                 java.lang.String... userIds)

Unfollow status updates for one or more users.

Parameters:

userIds - The ids of users to unfollow.

Returns:

A future.

updateStatus

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> updateStatus(java.lang.String status)

Update the user's status online.

Parameters:

status - The new status of the user.

Returns:

A future.

createParty

com.google.common.util.concurrent.ListenableFuture<Party> createParty(boolean open,
                                                                      int maxSize)

Create a party.

Parameters:

open - Whether the party will require join requests to be approved by the party leader.

maxSize - Maximum number of party members.

Returns:

A future which resolves to the party created.

joinParty

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> joinParty(@NonNull
                                                                             @NonNull java.lang.String partyId)

Join a party.

Parameters:

partyId - A party ID.

leaveParty

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> leaveParty(@NonNull
                                                                              @NonNull java.lang.String partyId)

Leave a party.

Parameters:

partyId - A party ID.

promoteParty

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> promoteParty(@NonNull
                                                                                @NonNull java.lang.String partyId,
                                                                                UserPresence userPresence)

Promote a member to party leader.

Parameters:

partyId - A party ID.

userPresence - The presence of an existing party member to promote as the new leader.

acceptParty

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> acceptParty(@NonNull
                                                                               @NonNull java.lang.String partyId,
                                                                               UserPresence userPresence)

Accept a member to a party.

Parameters:

partyId - Party ID to accept a join request for.

userPresence - The presence to accept as a party member.

removeParty

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> removeParty(@NonNull
                                                                               @NonNull java.lang.String partyId,
                                                                               UserPresence userPresence)

Remove/reject a member from a party.

Parameters:

partyId - Party ID to remove/reject from.

userPresence - The presence to remove or reject.

closeParty

com.google.common.util.concurrent.ListenableFuture<Party> closeParty(@NonNull
                                                                     @NonNull java.lang.String partyId)

End a party.

Parameters:

partyId - A party ID.

listPartyJoinRequest

com.google.common.util.concurrent.ListenableFuture<PartyJoinRequest> listPartyJoinRequest(@NonNull
                                                                                          @NonNull java.lang.String partyId)

Lists pending join requests for a party.

Parameters:

partyId - A party ID.

addPartyMatchmaker

com.google.common.util.concurrent.ListenableFuture<PartyMatchmakerTicket> addPartyMatchmaker(@NonNull
                                                                                             @NonNull java.lang.String partyId,
                                                                                             int minCount,
                                                                                             int maxCount,
                                                                                             @NonNull
                                                                                             @NonNull java.lang.String query,
                                                                                             java.util.Map<java.lang.String,java.lang.String> stringProperties,
                                                                                             java.util.Map<java.lang.String,java.lang.Double> numericProperties,
                                                                                             int countMultiple)

Begin matchmaking as a party.

Parameters:

minCount - Minimum total user count to match together.

maxCount - Maximum total user count to match together.

query - Filter query used to identify suitable users.

stringProperties - A set of k/v properties to provide in searches.

numericProperties - A set of k/v numeric properties to provide in searches.

countMultiple - Optional multiple of the count that must be satisfied.

Returns:

A future which resolves to a party matchmaker ticket object.

removePartyMatchmaker

com.google.common.util.concurrent.ListenableFuture<java.lang.Void> removePartyMatchmaker(@NonNull
                                                                                         @NonNull java.lang.String partyId,
                                                                                         @NonNull
                                                                                         @NonNull java.lang.String ticket)

Cancel a party matchmaking process using a ticket.

Parameters:

partyId - A party ID.

partyId - The ticket to cancel.

sendPartyData

void sendPartyData(@NonNull
                   @NonNull java.lang.String partyId,
                   int opCode,
                   @NonNull
                   @NonNull byte[] data)

Send party data.

Parameters:

partyId - The ID of the party.

opCode - An operation code for the party state.

data - The new state to send to the party.