GS2-Deploy/CDK Reference of GS2-Realtime

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Require	Limitation	Description
name	string	✓	~ 32 chars	Namespace name
description	string		~ 1024 chars	description of Namespace
serverType	string	✓	~ 128 chars	Server Type
serverSpec	string	✓	~ 128 chars	Server Spec
createNotification	NotificationSetting			Push notification when room creation is finished
logSetting	LogSetting			Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

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

A game server for communication processing of real-time matches. IP address, port, and encryption key will be assigned a short time after creation.

	Type	Require	Limitation	Description
ownerId	string	✓	~ 128 chars	Owner ID
namespaceName	string	✓	~ 32 chars	Namespace name
name	string	✓	~ 128 chars	Room Name
ipAddress	string		~ 128 chars	IP address
port	int		~ 65535	Standby port
encryptionKey	string		~ 256 chars	Encryption key

GetAttr

	Type	Description
Item	Room	Room

Implementation Example

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

	Type	Require	Limitation	Description
gatewayNamespaceId	string	✓	~ 1024 chars	Namespace GRN
enableTransferMobileNotification	bool?			Forwarding to mobile push notification
sound	string		~ 1024 chars	Sound file name to be used for mobile push notifications

LogSetting

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN