com.mixer.interactive.services

Class RemoteProcedureCallServiceProvider

java.lang.Object

com.mixer.interactive.services.AbstractServiceProvider

com.mixer.interactive.services.RemoteProcedureCallServiceProvider

public class RemoteProcedureCallServiceProvider
extends AbstractServiceProvider

Provides all functionality relating to making requests and interpreting replies from the Interactive service. In the majority of cases a developer would use makeRequest methods to send method requests to the Interactive service and interpret the reply. However in the event a developer would like to craft their own MethodPacket (e.g., to call a method that does not yet exist in the InteractiveMethod enum), send methods are available to accomplish this goal.

Since:

1.0.0

Author:

Microsoft Corporation

See Also:

InteractiveMethod, MethodPacket

Field Summary

Fields inherited from class com.mixer.interactive.services.AbstractServiceProvider

gameClient

Constructor Summary

Constructors

Constructor and Description
RemoteProcedureCallServiceProvider(GameClient gameClient) Initializes a new RemoteProcedureCallServiceProvider.

Method Summary

Modifier and Type	Method and Description
int	claimNextPacketId() Claims and returns the next available packet id.
int	getSequenceNumber() Returns the last seen sequence number.
CompletableFuture<Boolean>	makeRequest(InteractiveMethod method, com.google.gson.JsonElement params) Prepares and sends a request to the Interactive service.
<T> CompletableFuture<T>	makeRequest(InteractiveMethod method, com.google.gson.JsonElement params, String memberName, Type type) Prepares and sends a request to the Interactive service, returning the parsed reply.
<T> CompletableFuture<T>	makeRequest(InteractiveMethod method, com.google.gson.JsonElement params, Type type) Prepares and sends a request to the Interactive service, returning the parsed reply.
void	makeRequestNoReply(InteractiveMethod method, com.google.gson.JsonElement params) Prepares and sends a request to the Interactive service, expecting no reply.
Map<MethodPacket,CompletableFuture<ReplyPacket>>	send(Collection<MethodPacket> requestPackets) Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in the same order as the input collection.
Map<MethodPacket,CompletableFuture<ReplyPacket>>	send(Collection<MethodPacket> requestPackets, long duration, TimeUnit timeUnit) Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in the same order as the input collection.
CompletableFuture<ReplyPacket>	send(MethodPacket requestPacket) Sends a request to the Interactive service, returning the reply.
CompletableFuture<ReplyPacket>	send(MethodPacket requestPacket, long duration, TimeUnit timeUnit) Prepares and sends a request to the Interactive service, returning the parsed reply.

Methods inherited from class com.mixer.interactive.services.AbstractServiceProvider

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteProcedureCallServiceProvider

public RemoteProcedureCallServiceProvider(GameClient gameClient)

Initializes a new RemoteProcedureCallServiceProvider.

Parameters:

gameClient - The GameClient that owns this service provider

Since:

1.0.0

Method Detail

makeRequestNoReply

public void makeRequestNoReply(InteractiveMethod method,
                               com.google.gson.JsonElement params)

Prepares and sends a request to the Interactive service, expecting no reply.

Parameters:

method - An InteractiveMethod for the request

params - Json encoded map of parameters for the request

Since:

1.0.0

See Also:

MethodPacket

makeRequest

public CompletableFuture<Boolean> makeRequest(InteractiveMethod method,
                                              com.google.gson.JsonElement params)

Prepares and sends a request to the Interactive service.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

method - An InteractiveMethod for the request

params - Json encoded map of parameters for the request

Returns:

A CompletableFuture that when complete returns true for this request if it completes with no errors

Since:

1.0.0

See Also:

MethodPacket

makeRequest

public <T> CompletableFuture<T> makeRequest(InteractiveMethod method,
                                            com.google.gson.JsonElement params,
                                            Type type)

Prepares and sends a request to the Interactive service, returning the parsed reply.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Type Parameters:

T - Class of object to be parsed from the reply

Parameters:

method - An InteractiveMethod for the request

params - Json encoded map of parameters for the request

type - Type of object to be parsed from reply

Returns:

A CompletableFuture that when complete returns a T object parsed from the ReplyPacket sent back from the Interactive service for this request if it completes with no errors

Since:

1.0.0

See Also:

MethodPacket

makeRequest

public <T> CompletableFuture<T> makeRequest(InteractiveMethod method,
                                            com.google.gson.JsonElement params,
                                            String memberName,
                                            Type type)

Prepares and sends a request to the Interactive service, returning the parsed reply.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Type Parameters:

T - Class of object to be parsed from the reply

Parameters:

method - An InteractiveMethod for the request

params - Json encoded map of parameters for the request

memberName - Member name of parameter to be parsed from reply

type - Type of object to be parsed from reply

Returns:

A CompletableFuture that when complete returns a T object parsed from the ReplyPacket sent back from the Interactive service for this request if it completes with no errors

Since:

1.0.0

See Also:

MethodPacket

send

public CompletableFuture<ReplyPacket> send(MethodPacket requestPacket)

Sends a request to the Interactive service, returning the reply. If a reply is not received within the specified timeout duration, throws an InteractiveRequestNoReplyException exception.

Parameters:

requestPacket - A MethodPacket representing the request being sent

Returns:

A CompletableFuture that when complete returns the ReplyPacket sent back from the Interactive service for the provided method request

Since:

1.0.0

See Also:

MethodPacket

send

public CompletableFuture<ReplyPacket> send(MethodPacket requestPacket,
                                           long duration,
                                           TimeUnit timeUnit)

Prepares and sends a request to the Interactive service, returning the parsed reply.

The result of the CompletableFuture may include checked exceptions that were thrown in the event that there was a problem with the reply from the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned CompletableFuture.

Parameters:

requestPacket - A MethodPacket representing the request being sent

duration - Duration before request is considered timed out (no reply)

timeUnit - A TimeUnit indicating the units to be used in the timeout

Returns:

A CompletableFuture that when complete returns the ReplyPacket sent back from the Interactive service for the provided method request

Since:

1.0.0

See Also:

MethodPacket

send

public Map<MethodPacket,CompletableFuture<ReplyPacket>> send(Collection<MethodPacket> requestPackets)

Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in the same order as the input collection.

The result of each reply may include checked exceptions that were thrown in the event that there was a problem with the request to the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned list.

Parameters:

requestPackets - A Collection of MethodPacket representing the requests being sent

Returns:

A List of CompletableFutures that when complete return the ReplyPacket for the corresponding input MethodPacket. This list is in the same order as the input collection.

Since:

1.0.0

send

public Map<MethodPacket,CompletableFuture<ReplyPacket>> send(Collection<MethodPacket> requestPackets,
                                                             long duration,
                                                             TimeUnit timeUnit)

Prepares and sends one or many requests to the Interactive service, returning a list of replies that are in the same order as the input collection.

The result of each reply may include checked exceptions that were thrown in the event that there was a problem with the request to the Interactive service. Specifically, two types of checked exceptions may be thrown:

• InteractiveRequestNoReplyException may be thrown if no reply is received from the Interactive service.
• InteractiveReplyWithErrorException may be thrown if the reply received from the Interactive service contains an InteractiveError.

Considerations should be made for these possibilities when interpreting the results of the returned list.

Parameters:

requestPackets - A Collection of MethodPacket representing the requests being sent

duration - Duration before request is considered timed out (no reply)

timeUnit - A TimeUnit indicating the units to be used in the timeout

Returns:

A List of CompletableFutures that when complete return the ReplyPacket for the corresponding input MethodPacket. This list is in the same order as the input collection.

Since:

1.0.0

claimNextPacketId

public int claimNextPacketId()

Claims and returns the next available packet id.

Returns:

The next available packet id

Since:

1.0.0

See Also:

InteractiveWebSocketClient.claimNextPacketId()

getSequenceNumber

public int getSequenceNumber()

Returns the last seen sequence number.

Returns:

The last seen sequence number

Since:

2.0.0

See Also:

InteractiveWebSocketClient.getLastSequenceNumber()