Show / Hide Table of Contents

Class WebAPI

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

Inheritance
java.lang.Object
org.nanohttpd.protocols.http.NanoHTTPD
org.nanohttpd.router.RouterNanoHTTPD
WebAPI
Inherited Members
java.lang.Object.clone()
java.lang.Object.equals(java.lang.Object)
java.lang.Object.finalize()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long,int)
org.nanohttpd.protocols.http.NanoHTTPD.addHTTPInterceptor(org.nanohttpd.util.IHandler<org.nanohttpd.protocols.http.IHTTPSession,org.nanohttpd.protocols.http.response.Response>)
org.nanohttpd.protocols.http.NanoHTTPD.closeAllConnections()
org.nanohttpd.protocols.http.NanoHTTPD.createClientHandler(java.net.Socket,java.io.InputStream)
org.nanohttpd.protocols.http.NanoHTTPD.createServerRunnable(int)
org.nanohttpd.protocols.http.NanoHTTPD.decodeParameters(java.lang.String)
org.nanohttpd.protocols.http.NanoHTTPD.decodeParameters(java.util.Map<java.lang.String,java.lang.String>)
org.nanohttpd.protocols.http.NanoHTTPD.decodePercent(java.lang.String)
org.nanohttpd.protocols.http.NanoHTTPD.getHostname()
org.nanohttpd.protocols.http.NanoHTTPD.getListeningPort()
org.nanohttpd.protocols.http.NanoHTTPD.getMimeTypeForFile(java.lang.String)
org.nanohttpd.protocols.http.NanoHTTPD.getMyServerSocket()
org.nanohttpd.protocols.http.NanoHTTPD.getServerSocketFactory()
org.nanohttpd.protocols.http.NanoHTTPD.getTempFileManagerFactory()
org.nanohttpd.protocols.http.NanoHTTPD.handle(org.nanohttpd.protocols.http.IHTTPSession)
org.nanohttpd.protocols.http.NanoHTTPD.isAlive()
org.nanohttpd.protocols.http.NanoHTTPD.makeSSLSocketFactory(java.lang.String,char[])
org.nanohttpd.protocols.http.NanoHTTPD.makeSSLSocketFactory(java.security.KeyStore,javax.net.ssl.KeyManagerFactory)
org.nanohttpd.protocols.http.NanoHTTPD.makeSSLSocketFactory(java.security.KeyStore,javax.net.ssl.KeyManager[])
org.nanohttpd.protocols.http.NanoHTTPD.makeSecure(javax.net.ssl.SSLServerSocketFactory,java.lang.String[])
org.nanohttpd.protocols.http.NanoHTTPD.mimeTypes()
org.nanohttpd.protocols.http.NanoHTTPD.safeClose(java.lang.Object)
org.nanohttpd.protocols.http.NanoHTTPD.setAsyncRunner(org.nanohttpd.protocols.http.threading.IAsyncRunner)
org.nanohttpd.protocols.http.NanoHTTPD.setHTTPHandler(org.nanohttpd.util.IHandler<org.nanohttpd.protocols.http.IHTTPSession,org.nanohttpd.protocols.http.response.Response>)
org.nanohttpd.protocols.http.NanoHTTPD.setServerSocketFactory(org.nanohttpd.util.IFactoryThrowing<java.net.ServerSocket,java.io.IOException>)
org.nanohttpd.protocols.http.NanoHTTPD.setTempFileManagerFactory(org.nanohttpd.util.IFactory<org.nanohttpd.protocols.http.tempfiles.ITempFileManager>)
org.nanohttpd.protocols.http.NanoHTTPD.start()
org.nanohttpd.protocols.http.NanoHTTPD.start(int)
org.nanohttpd.protocols.http.NanoHTTPD.start(int,boolean)
org.nanohttpd.protocols.http.NanoHTTPD.stop()
org.nanohttpd.protocols.http.NanoHTTPD.wasStarted()
org.nanohttpd.router.RouterNanoHTTPD.<T>setNotFoundHandler(java.lang.Class<T>)
org.nanohttpd.router.RouterNanoHTTPD.<T>setNotImplementedHandler(java.lang.Class<T>)
org.nanohttpd.router.RouterNanoHTTPD.addMappings()
org.nanohttpd.router.RouterNanoHTTPD.addRoute(java.lang.String,java.lang.Class<?>,java.lang.Object...)
org.nanohttpd.router.RouterNanoHTTPD.normalizeUri(java.lang.String)
org.nanohttpd.router.RouterNanoHTTPD.removeRoute(java.lang.String)
org.nanohttpd.router.RouterNanoHTTPD.serve(org.nanohttpd.protocols.http.IHTTPSession)
org.nanohttpd.router.RouterNanoHTTPD.setRoutePrioritizer(org.nanohttpd.router.RouterNanoHTTPD.IRoutePrioritizer)
Namespace:
Assembly: .dll
Syntax
public class WebAPI extends RouterNanoHTTPD

Fields

SESSION_ALREADY_CLOSED_RESPONSE

Should be returned if session specific data like statistics or images were sent, but the session was already closed.

Declaration
public static final String SESSION_ALREADY_CLOSED_RESPONSE
Field Value
Type Description
java.lang.String

Methods

addMappings()

Adds the controllers for the endpoints.

Declaration
public void addMappings()
Overrides
org.nanohttpd.router.RouterNanoHTTPD.addMappings()

getInstance()

Gets the singelton instance

Declaration
public static WebAPI getInstance()
Returns
Type Description

The instance

getSessionAdministration()

The SessionAdministration of the WebApi instance.

Declaration
public SessionAdministration getSessionAdministration()
Returns
Type Description
SessionAdministration

restart()

Restarts the WebApi, SessionListenerFactory and SessionWatchdog.

Declaration
public void restart()

shutdown()

Shutsdown the WebApi, SessionListenerFactory and SessionWatchdog.

Declaration
public void shutdown()

start()

Starts the WebApi, SessionListenerFactory, SessionWatchdog.

Declaration
public void start()
Overrides
org.nanohttpd.protocols.http.NanoHTTPD.start()
Exceptions
Type Condition
java.io.IOException
In This Article
Back to top Generated by DocFX