GS2-Realtime GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | ✓ | | ~ 32文字 | ネームスペース名 |
description | string | | | ~ 1024文字 | 説明文 |
serverType | string | ✓ | | ~ 128文字 | サーバの種類 |
serverSpec | string | ✓ | | ~ 128文字 | サーバのスペック |
createNotification | NotificationSetting | | | | ルームの作成が終わったときのプッシュ通知 |
logSetting | LogSetting | | | | ログの出力設定 |
GetAttr
実装例
Type: GS2::Realtime::Namespace
Properties:
Name: namespace1
Description: null
ServerType: relay
ServerSpec: realtime1.nano
CreateNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, realtime
class SampleStack(Stack):
def __init__(self):
super().__init__()
realtime.Namespace(
stack=self,
name="namespace-0001",
server_type=realtime.NamespaceServerType.RELAY,
server_spec=realtime.NamespaceServerSpec.REALTIME1_NANO,
options=realtime.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Realtime\Model\Namespace_(
stack: $this,
name: "namespace-0001",
serverType: \Gs2Cdk\Realtime\Model\Enum\NamespaceServerType::RELAY,
serverSpec: \Gs2Cdk\Realtime\Model\Enum\NamespaceServerSpec::REALTIME1_NANO,
options: new \Gs2Cdk\Realtime\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.realtime.model.Namespace(
this,
"namespace-0001",
io.gs2.cdk.realtime.model.enums.NamespaceServerType.RELAY,
io.gs2.cdk.realtime.model.enums.NamespaceServerSpec.REALTIME1_NANO,
new io.gs2.cdk.realtime.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import realtime from "@/gs2cdk/realtime";
class SampleStack extends core.Stack
{
public constructor() {
super();
new realtime.model.Namespace(
this,
"namespace-0001",
realtime.model.NamespaceServerType.RELAY,
realtime.model.NamespaceServerSpec.REALTIME1_NANO,
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Realtime.Model.Namespace(
this,
"namespace-0001",
Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerType.Relay,
Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerSpec.Realtime1Nano,
new Gs2Cdk.Gs2Realtime.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
Room
ルーム
リアルタイム対戦の通信処理を行う為のゲームサーバー。
作成後しばらくしてから IPアドレス・ポート・暗号鍵 がアサインされます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
ownerId | string | ✓ | | ~ 128文字 | オーナーID |
namespaceName | string | ✓ | | ~ 32文字 | ネームスペース名 |
name | string | ✓ | | ~ 128文字 | ルーム名 |
ipAddress | string | | | ~ 128文字 | IPアドレス |
port | int | | | ~ 65535 | 待受ポート |
encryptionKey | string | | | ~ 256文字 | 暗号鍵 |
GetAttr
実装例
Type: GS2::Realtime::Room
Properties:
OwnerId: null
NamespaceName: namespace1
Name: null
IpAddress: 192.168.0.1
Port: 50000
EncryptionKey: aaa
from gs2_cdk import Stack, core, realtime
class SampleStack(Stack):
def __init__(self):
super().__init__()
realtime.Room(
stack=self,
namespace_name="namespace-0001",
options=realtime.RoomOptions(
ip_address='192.168.0.1',
port=50000,
encryption_key='aaa',
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Realtime\Model\Room(
stack: $this,
namespaceName: "namespace-0001",
options: new \Gs2Cdk\Realtime\Model\Options\RoomOptions(
ipAddress: "192.168.0.1",
port: 50000,
encryptionKey: "aaa",
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.realtime.model.Room(
this,
"namespace-0001",
new io.gs2.cdk.realtime.model.options.RoomOptions() {
{
ipAddress = "192.168.0.1";
port = 50000;
encryptionKey = "aaa";
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import realtime from "@/gs2cdk/realtime";
class SampleStack extends core.Stack
{
public constructor() {
super();
new realtime.model.Room(
this,
"namespace-0001",
{
ipAddress: "192.168.0.1",
port: 50000,
encryptionKey: "aaa"
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Realtime.Model.Room(
this,
"namespace-0001",
new Gs2Cdk.Gs2Realtime.Model.Options.RoomOptions {
ipAddress = "192.168.0.1",
port = 50000,
encryptionKey = "aaa",
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
NotificationSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
gatewayNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |
enableTransferMobileNotification | bool? | | | | モバイルプッシュ通知へ転送するか |
sound | string | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
LogSetting
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | ✓ | | ~ 1024文字 | ネームスペースGRN |