io.gs2.realtime

Class Gs2RealtimeClient

java.lang.Object

io.gs2.AbstractGs2Client<Gs2RealtimeClient>

io.gs2.realtime.Gs2RealtimeClient

public class Gs2RealtimeClient
extends AbstractGs2Client<Gs2RealtimeClient>

GS2 Realtime API クライアント

Author:

Game Server Services, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT

Fields inherited from class io.gs2.AbstractGs2Client

credential, region

Constructor Summary

Constructors

Constructor and Description
Gs2RealtimeClient(IGs2Credential credential) コンストラクタ。

Method Summary

Modifier and Type	Method and Description
CreateGatheringResult	createGathering(CreateGatheringRequest request) ギャザリングを作成。 ギャザリングを作成すると、ゲームサーバが起動します。 ゲームサーバはWebSocketで接続することができ、同じゲームサーバに接続しているユーザ間でメッセージをやり取りすることができます。 ゲームサーバとの通信プロトコルの説明については別途ドキュメントを確認してください。 userIds にユーザIDを指定することで、ギャザリングに参加できるユーザのIDを制限することができます。 ギャザリング作成時に参加するユーザが確定している場合は指定してください。 省略すると、暗号鍵を知っていれば誰でも参加することができます。
CreateGatheringPoolResult	createGatheringPool(CreateGatheringPoolRequest request) ギャザリングプールを作成。 GS2-Realtime を利用するには、まずギャザリングプールを作成する必要があります。 ギャザリングプールには複数のギャザリングを紐付けることができます。
void	deleteGathering(DeleteGatheringRequest request) ギャザリングを削除。
void	deleteGatheringPool(DeleteGatheringPoolRequest request) ギャザリングプールを削除。
DescribeGatheringResult	describeGathering(DescribeGatheringRequest request) ギャザリング一覧を取得。
DescribeGatheringPoolResult	describeGatheringPool(DescribeGatheringPoolRequest request) ギャザリングプール一覧を取得。
GetGatheringResult	getGathering(GetGatheringRequest request) ギャザリングを取得。
GetGatheringPoolResult	getGatheringPool(GetGatheringPoolRequest request) ギャザリングプールを取得。
UpdateGatheringPoolResult	updateGatheringPool(UpdateGatheringPoolRequest request) ギャザリングプールを作成。

Methods inherited from class io.gs2.AbstractGs2Client

createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

Methods inherited from class java.lang.Object

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

Field Detail

ENDPOINT

public static String ENDPOINT

Constructor Detail

Gs2RealtimeClient

public Gs2RealtimeClient(IGs2Credential credential)

コンストラクタ。

Parameters:

credential - 認証情報

Method Detail

createGatheringPool

public CreateGatheringPoolResult createGatheringPool(CreateGatheringPoolRequest request)

ギャザリングプールを作成。

GS2-Realtime を利用するには、まずギャザリングプールを作成する必要があります。
ギャザリングプールには複数のギャザリングを紐付けることができます。

Parameters:

request - リクエストパラメータ

Returns:

作成結果

describeGatheringPool

public DescribeGatheringPoolResult describeGatheringPool(DescribeGatheringPoolRequest request)

ギャザリングプール一覧を取得。

Parameters:

request - リクエストパラメータ

Returns:

ギャザリングプール一覧

getGatheringPool

public GetGatheringPoolResult getGatheringPool(GetGatheringPoolRequest request)

ギャザリングプールを取得。

Parameters:

request - リクエストパラメータ

Returns:

ギャザリングプール

updateGatheringPool

public UpdateGatheringPoolResult updateGatheringPool(UpdateGatheringPoolRequest request)

ギャザリングプールを作成。

Parameters:

request - リクエストパラメータ

Returns:

作成結果

deleteGatheringPool

public void deleteGatheringPool(DeleteGatheringPoolRequest request)

ギャザリングプールを削除。

Parameters:

request - リクエストパラメータ

createGathering

public CreateGatheringResult createGathering(CreateGatheringRequest request)

ギャザリングを作成。

ギャザリングを作成すると、ゲームサーバが起動します。
ゲームサーバはWebSocketで接続することができ、同じゲームサーバに接続しているユーザ間でメッセージをやり取りすることができます。
ゲームサーバとの通信プロトコルの説明については別途ドキュメントを確認してください。

userIds にユーザIDを指定することで、ギャザリングに参加できるユーザのIDを制限することができます。
ギャザリング作成時に参加するユーザが確定している場合は指定してください。
省略すると、暗号鍵を知っていれば誰でも参加することができます。

Parameters:

request - リクエストパラメータ

Returns:

作成結果

describeGathering

public DescribeGatheringResult describeGathering(DescribeGatheringRequest request)

ギャザリング一覧を取得。

Parameters:

request - リクエストパラメータ

Returns:

ギャザリング一覧

getGathering

public GetGatheringResult getGathering(GetGatheringRequest request)

ギャザリングを取得。

Parameters:

request - リクエストパラメータ

Returns:

ギャザリング

deleteGathering

public void deleteGathering(DeleteGatheringRequest request)

ギャザリングを削除。

Parameters:

request - リクエストパラメータ