Package net.targetr.rc.client

Class JavaScriptSnippets

java.lang.Object

net.targetr.rc.client.JavaScriptSnippets

public class JavaScriptSnippets
extends Object

JavaScript snippets to help clients perform updates.

Author:

Dr Michael Gardiner

Constructor Summary

Constructors

Constructor	Description
JavaScriptSnippets()	Constructs a new JavaScriptSnippets.

Method Summary

Modifier and Type	Method	Description
static String	createNoUpdate()	Creates a snippet to tell the client there are no pending updates.
static String	createRoomFull(int maxClients)	Stops automatic reconnects and displays an error when a room is full.
static String	createUpdateHeader(String version)	Creates a snippet to inform the client of a server update.
static String	createWsStart()	Creates a snippet to notify the client that the WebSocket is active.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaScriptSnippets

public JavaScriptSnippets()

Constructs a new JavaScriptSnippets.

Method Details

createUpdateHeader

public static String createUpdateHeader(String version)

Creates a snippet to inform the client of a server update.

Parameters:

version - the current server version

Returns:

the JavaScript string

createNoUpdate

public static String createNoUpdate()

Creates a snippet to tell the client there are no pending updates.

Returns:

the JavaScript string

createWsStart

public static String createWsStart()

Creates a snippet to notify the client that the WebSocket is active.

Returns:

the JavaScript string

createRoomFull

public static String createRoomFull(int maxClients)

Stops automatic reconnects and displays an error when a room is full. Uses existing client APIs so pages loaded before the server update can run it.

Parameters:

maxClients - the room's client limit

Returns:

the JavaScript string