Show / Hide Table of Contents

Namespace org.visab.api

This package contains the high level classes for the HTTP Server API of VISAB.

The HTTP (web) API is the data transmission end point for any game that is communicating with VISAB to send its game data to be visualized. Despite games there may be other use cases in the future that implement some communication with the VISAB API. E.g. exposing files from the database to other services.

Classes

SessionAdministration

The SessionAdministration class is used for administering the current transmission sessions. It has a list of all the transmission sessions that are currently open and publishes all API related events.

SessionWatchdog

The SessionWatchdog watches the currently active tranmission sessions, checks if they should be timeouted and timeouts them if needed.

WebAPI

The HTTP-Protocol based WebAPI that can be used by game clients. Most importantly used for reciving images and statistics of games.

WebAPIHelper

A helper class containing various methods that are used by the HTTP controllers.

In This Article
Back to top Generated by DocFX