Class NanoWSD

java.lang.Object

fi.iki.elonen.NanoHTTPD

fi.iki.elonen.NanoWSD

Direct Known Subclasses:

DebugWebSocketServer

public abstract class NanoWSD
extends NanoHTTPD

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NanoWSD.State
static class	NanoWSD.WebSocket
static class	NanoWSD.WebSocketException
static class	NanoWSD.WebSocketFrame

Nested classes/interfaces inherited from class NanoHTTPD

NanoHTTPD.AsyncRunner, NanoHTTPD.ClientHandler, NanoHTTPD.ContentType, NanoHTTPD.Cookie, NanoHTTPD.CookieHandler, NanoHTTPD.DefaultAsyncRunner, NanoHTTPD.DefaultServerSocketFactory, NanoHTTPD.DefaultTempFile, NanoHTTPD.DefaultTempFileManager, NanoHTTPD.HTTPSession, NanoHTTPD.IHTTPSession, NanoHTTPD.Method, NanoHTTPD.Response, NanoHTTPD.ResponseException, NanoHTTPD.SecureServerSocketFactory, NanoHTTPD.ServerRunnable, NanoHTTPD.ServerSocketFactory, NanoHTTPD.TempFile, NanoHTTPD.TempFileManager, NanoHTTPD.TempFileManagerFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEADER_CONNECTION
static final String	HEADER_CONNECTION_VALUE
static final String	HEADER_UPGRADE
static final String	HEADER_UPGRADE_VALUE
static final String	HEADER_WEBSOCKET_ACCEPT
static final String	HEADER_WEBSOCKET_KEY
static final String	HEADER_WEBSOCKET_PROTOCOL
static final String	HEADER_WEBSOCKET_VERSION
static final String	HEADER_WEBSOCKET_VERSION_VALUE

Fields inherited from class NanoHTTPD

asyncRunner, MIME_HTML, MIME_PLAINTEXT, MIME_TYPES, SOCKET_READ_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
NanoWSD(int port)
NanoWSD(String hostname, int port)

Method Summary

Modifier and Type	Method	Description
protected boolean	isWebsocketRequested(NanoHTTPD.IHTTPSession session)
static String	makeAcceptKey(String key)
protected abstract NanoWSD.WebSocket	openWebSocket(NanoHTTPD.IHTTPSession handshake)
NanoHTTPD.Response	serve(NanoHTTPD.IHTTPSession session)	Override this to customize the server.
protected NanoHTTPD.Response	serveHttp(NanoHTTPD.IHTTPSession session)
protected boolean	useGzipWhenAccepted(NanoHTTPD.Response r)	not all websockets implementations accept gzip compression.

Methods inherited from class NanoHTTPD

closeAllConnections, createClientHandler, createServerRunnable, decodeParameters, decodeParameters, decodePercent, getHostname, getListeningPort, getMimeTypeForFile, getServerSocketFactory, getTempFileManagerFactory, isAlive, makeSecure, makeSSLSocketFactory, makeSSLSocketFactory, makeSSLSocketFactory, mimeTypes, newChunkedResponse, newFixedLengthResponse, newFixedLengthResponse, newFixedLengthResponse, serve, setAsyncRunner, setServerSocketFactory, setTempFileManagerFactory, start, start, start, stop, wasStarted

Methods inherited from class Object

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

Field Details

HEADER_UPGRADE

public static final String HEADER_UPGRADE

See Also:

• Constant Field Values

HEADER_UPGRADE_VALUE

public static final String HEADER_UPGRADE_VALUE

See Also:

• Constant Field Values

HEADER_CONNECTION

public static final String HEADER_CONNECTION

See Also:

• Constant Field Values

HEADER_CONNECTION_VALUE

public static final String HEADER_CONNECTION_VALUE

See Also:

• Constant Field Values

HEADER_WEBSOCKET_VERSION

public static final String HEADER_WEBSOCKET_VERSION

See Also:

• Constant Field Values

HEADER_WEBSOCKET_VERSION_VALUE

public static final String HEADER_WEBSOCKET_VERSION_VALUE

See Also:

• Constant Field Values

HEADER_WEBSOCKET_KEY

public static final String HEADER_WEBSOCKET_KEY

See Also:

• Constant Field Values

HEADER_WEBSOCKET_ACCEPT

public static final String HEADER_WEBSOCKET_ACCEPT

See Also:

• Constant Field Values

HEADER_WEBSOCKET_PROTOCOL

public static final String HEADER_WEBSOCKET_PROTOCOL

See Also:

• Constant Field Values

Constructor Details

NanoWSD

public NanoWSD(int port)

NanoWSD

public NanoWSD(String hostname,
 int port)

Method Details

makeAcceptKey

public static String makeAcceptKey(String key)
                            throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

isWebsocketRequested

protected boolean isWebsocketRequested(NanoHTTPD.IHTTPSession session)

openWebSocket

protected abstract NanoWSD.WebSocket openWebSocket(NanoHTTPD.IHTTPSession handshake)

serve

public NanoHTTPD.Response serve(NanoHTTPD.IHTTPSession session)

Description copied from class: NanoHTTPD

Override this to customize the server.

(By default, this returns a 404 "Not Found" plain text error response.)

Overrides:

serve in class NanoHTTPD

Parameters:

session - The HTTP session

Returns:

HTTP response, see class Response for details

serveHttp

protected NanoHTTPD.Response serveHttp(NanoHTTPD.IHTTPSession session)

useGzipWhenAccepted

protected boolean useGzipWhenAccepted(NanoHTTPD.Response r)

not all websockets implementations accept gzip compression.

Overrides:

useGzipWhenAccepted in class NanoHTTPD

Returns:

true if the gzip compression should be used if the client accespts it. Default this option is on for text content and off for everything. Override this for custom semantics.