TCP サーバー

概要

TCP サーバーは、Diarkis の3つのリアルタイム通信サーバのうちの1つで、アプリケーションのためのカスタム・コマンドを実装することができます。

コマンドとは、クライアントから送信され、サーバで処理されるフォーマットされたパケットのことです。これは、Diarkis のサーバ・クラスターがクライアントと対話する方法です。

TCP サーバーのセットアップ

クライアントにビルトイン・コマンドを公開するには、diarkisexec パッケージを利用してセットアップできます。

• diarkisexec.SetupDiarkis() でモジュールを指定してビルトイン・コマンドを公開できます。各モジュールの ConfigPath を指定することで、設定をカスタマイズできます。

• diarkisexec.SetServerCommandHandler() でカスタム・コマンドを公開できます。

• diarkisexec.SetupDiarkisUDPServer() で UDP サーバーのセットアップができます。引数の JSON ファイルでサーバーの設定をカスタマイズできます。

⚠️上記の関数は、 diarkisexec.StartDiarkis() を呼ぶ前に実行する必要があります。

詳細は diarkisexec の API リファレンスを参照して下さい。

package main

import (
	"github.com/Diarkis/diarkis/diarkisexec"
	"github.com/Diarkis/diarkis/server"
	"github.com/Diarkis/diarkis/user"
)

var ver uint8 = 10
var cmd uint16 = 100

func main() {
	logConfigPath := "/configs/shared/log.json"
	meshConfigPath := "/configs/shared/mesh.json"

	diarkisexec.SetupDiarkis(logConfigPath, meshConfigPath, &diarkisexec.Modules{
		Room:       &diarkisexec.Options{ExposeCommands: true},
		Group:      &diarkisexec.Options{ConfigPath: "/configs/shared/group.json", ExposeCommands: true},
		Dive:       &diarkisexec.Options{ConfigPath: "/configs/shared/dive.json", ExposeCommands: true},
		Field:      &diarkisexec.Options{ConfigPath: "/configs/shared/field.json", ExposeCommands: true},
		DM:         &diarkisexec.Options{ConfigPath: "/configs/shared/dm.json", ExposeCommands: true},
		MatchMaker: &diarkisexec.Options{ConfigPath: "/configs/shared/matching.json", ExposeCommands: true},
		Session:    &diarkisexec.Options{ConfigPath: "/configs/shared/session.json", ExposeCommands: true},
	})

	diarkisexec.SetupDiarkisTCPServer("/configs/tcp/main.json")

	diarkisexec.SetServerCommandHandler(ver, cmd, helloWorld)

	diarkisexec.StartDiarkis()
}

func helloWorld(ver uint8, cmd uint16, payload []byte, userData *user.User, next func(error)) {
	userData.ServerRespond([]byte("Hello World"), ver, cmd, server.Ok, true)
	next(nil)
}

Mesh 設定

meshConfigPath には JSON ファイルのパスを指定します。詳細は Mesh 設定 を参照してください。

TCP サーバの設定

設定は JSON で記述します。

{
  "connectionTTL": 10,
  "address": "127.0.0.1",
  "nic": "eth0",
  "port": "7200",
  "maxRcvSize": 8000,
  "noDelay": false,
  "enableEncryption": true
}

キー	デフォルト
connectionTTL	10	接続の TTL。この時間を超えるとクライアントはサーバーから切断されます。
address	"127.0.0.1"	バインドする UDP サーバーのアドレス
nic	"eth0"	アドレスを取得するインターフェース名。アドレスが未指定の場合に利用します。
port	"7100"	UDP サーバーがバインドするためのポート。UDP サーバーは、指定されたポートから始まる利用可能なポートを自動的に探します。
maxRcvSize	8000	各リクエスト・パケットの最大 TCP パケット・サイズ（バイト）
noDelay	false	true に設定すると、Nagle アルゴリズムを無効にします(書き込み前のバッファリングなし)
enableEncryption	true	false に設定すると、パケットの暗号化と復号化が無効になります。HTTP サーバも同様の設定をする必要があります。

⚠️ クラウド環境では、address はプライベート IP アドレスとし、環境変数 DIARKIS_CLOUD_ENV を併用してください。

詳細は server の API リファレンスを参照して下さい。