Turn on Maintenance mode from Server

メンテモードの導入と解除

サーバが任意のhttpリクエストに対して特定のレスポンスコードを返すと、アプリケーション側でMaintenanceモードが起動する。

Maintenanceモードが起動すると、次のことが起こる。

• Maintenance機構が着火する
• すべてのhttp requestが失敗し、AutoyaStatus パラメータが inMaintenance = trueを返すようになる。

Maintenance_SetOnMaintenance(Func onMaintenance) 関数のonMaintenanceに任意の関数を渡しておくことで、メンテ時に実行するコードを事前に用意することができる。

Maintenance機構の詳細については、MaintenanceのAPIを参照。

特定のレスポンスコード

デフォルトでは、クライアントのリクエストに対してサーバが http response code 599 を返した場合、クライアントは「サーバはメンテ中」という判定をする。

このコードは　BackyardSettings.cs で定義されている。

public const int MAINTENANCE_CODE = 599;

解除

クライアントからのリクエストに際してサーバが特定のコードを返さなくなれば、以降は通常の通信が行われる。