Package com.pixelservices.flash.components

Class FlashServer

java.lang.Object

com.pixelservices.flash.components.FlashServer

public class FlashServer
extends Object

Flash is a highly optimized, asynchronous and multithreaded web server.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BUFFER_POOL_SIZE
static final int	BUFFER_SIZE
static final OffHeapBufferPool	REQUEST_BUFFER_POOL
static final OffHeapBufferPool	WEBSOCKET_BUFFER_POOL
static final int	WEBSOCKET_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
FlashServer(int port)
FlashServer(int port, FlashConfiguration config)

Method Summary

Modifier and Type	Method	Description
void	after(String endpoint, SimpleHandler handler)
void	afterAfter(String endpoint, SimpleHandler handler)
void	before(String endpoint, SimpleHandler handler)
static void	closeSocket(AsynchronousSocketChannel clientChannel)
void	connect(String endpoint, SimpleHandler handler)
void	delete(String endpoint, SimpleHandler handler)
void	enableCORS(String allowedOrigins, String allowedMethods, String allowedHeaders)
void	get(String endpoint, SimpleHandler handler)
HandlerPoolManager	getHandlerPoolManager()
Map<String,RequestHandler>	getRouteHandlers()
void	head(String endpoint, SimpleHandler handler)
boolean	isRunning()	Checks if the server is currently running.
OpenAPISchemaGenerator	openapi(String endpoint, OpenAPIConfiguration configuration, OpenAPIUITemplate templateHtml)
void	options(String endpoint, SimpleHandler handler)
static RequestInfo	parseRequest(String rawRequest)
void	patch(String endpoint, SimpleHandler handler)
void	post(String endpoint, SimpleHandler handler)
boolean	processMiddleware(String path, Request request, Response response)
void	put(String endpoint, SimpleHandler handler)
void	redirect(String fromPath, String toPath)
void	redirect(String fromPath, String toPath, HttpMethod method)
void	registerRoute(HttpMethod method, String fullPath, RequestHandler handler)
void	registerRoute(HttpMethod method, String fullPath, SimpleHandler handler)
void	registerRoute(HttpMethod method, String fullPath, SimpleHandler handler, HandlerType handlerType)
Router	route(String basePath)
void	serveDynamic(String endpoint, DynamicFileServerConfiguration config)
void	serveDynamic(String endpoint, DynamicFileServerConfiguration config, Class<?> contextClass)
void	serveStatic(String endpoint, StaticFileServerConfiguration config)
Thread	start()	Starts the server and binds to the specified port.
void	stop()	Stops the server safely.
void	trace(String endpoint, SimpleHandler handler)
void	unregisterRoute(HttpMethod method, String fullPath)
void	use(Middleware middleware)
void	use(String pathPrefix, Middleware middleware)
void	ws(String endpoint, WebSocketHandler handler)

Methods inherited from class java.lang.Object

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

Field Details

BUFFER_POOL_SIZE

public static final int BUFFER_POOL_SIZE

See Also:

• Constant Field Values

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

• Constant Field Values

REQUEST_BUFFER_POOL

public static final OffHeapBufferPool REQUEST_BUFFER_POOL

WEBSOCKET_BUFFER_SIZE

public static final int WEBSOCKET_BUFFER_SIZE

See Also:

• Constant Field Values

WEBSOCKET_BUFFER_POOL

public static final OffHeapBufferPool WEBSOCKET_BUFFER_POOL

Constructor Details

FlashServer

public FlashServer(int port,
 FlashConfiguration config)

FlashServer

public FlashServer(int port)

Method Details

start

public Thread start()

Starts the server and binds to the specified port. This method is non-blocking and returns a thread that can be used to wait for the server to stop.

Returns:

The thread running the server

stop

public void stop()

Stops the server safely. This method blocks until the server has fully stopped.

isRunning

public boolean isRunning()

Checks if the server is currently running.

Returns:

true if the server is running, false otherwise

use

public void use(Middleware middleware)

use

public void use(String pathPrefix,
 Middleware middleware)

enableCORS

public void enableCORS(String allowedOrigins,
 String allowedMethods,
 String allowedHeaders)

route

public Router route(String basePath)

registerRoute

public void registerRoute(HttpMethod method,
 String fullPath,
 RequestHandler handler)

registerRoute

public void registerRoute(HttpMethod method,
 String fullPath,
 SimpleHandler handler)

registerRoute

public void registerRoute(HttpMethod method,
 String fullPath,
 SimpleHandler handler,
 HandlerType handlerType)

unregisterRoute

public void unregisterRoute(HttpMethod method,
 String fullPath)

redirect

public void redirect(String fromPath,
 String toPath,
 HttpMethod method)

redirect

public void redirect(String fromPath,
 String toPath)

parseRequest

public static RequestInfo parseRequest(String rawRequest)

processMiddleware

public boolean processMiddleware(String path,
 Request request,
 Response response)

closeSocket

public static void closeSocket(AsynchronousSocketChannel clientChannel)

openapi

public OpenAPISchemaGenerator openapi(String endpoint,
 OpenAPIConfiguration configuration,
 OpenAPIUITemplate templateHtml)

serveStatic

public void serveStatic(String endpoint,
 StaticFileServerConfiguration config)

serveDynamic

public void serveDynamic(String endpoint,
 DynamicFileServerConfiguration config)

serveDynamic

public void serveDynamic(String endpoint,
 DynamicFileServerConfiguration config,
 Class<?> contextClass)

ws

public void ws(String endpoint,
 WebSocketHandler handler)

get

public void get(String endpoint,
 SimpleHandler handler)

post

public void post(String endpoint,
 SimpleHandler handler)

put

public void put(String endpoint,
 SimpleHandler handler)

delete

public void delete(String endpoint,
 SimpleHandler handler)

patch

public void patch(String endpoint,
 SimpleHandler handler)

head

public void head(String endpoint,
 SimpleHandler handler)

trace

public void trace(String endpoint,
 SimpleHandler handler)

connect

public void connect(String endpoint,
 SimpleHandler handler)

options

public void options(String endpoint,
 SimpleHandler handler)

before

public void before(String endpoint,
 SimpleHandler handler)

after

public void after(String endpoint,
 SimpleHandler handler)

afterAfter

public void afterAfter(String endpoint,
 SimpleHandler handler)

getRouteHandlers

public Map<String,RequestHandler> getRouteHandlers()

getHandlerPoolManager

public HandlerPoolManager getHandlerPoolManager()