ServerUniverseNative class
Server application class
This is the core of the server application. Generally you would create one for each app.
- Inheritance
-
- Object
- ServerUniverse
- ServerUniverseNative
- Available Extensions
Constructors
- ServerUniverseNative({String pathPrefix = '', FutureOr onNotFound(HttpRequest req, HttpResponse res)?, FutureOr onError(HttpRequest req, HttpResponse res, Object error, StackTrace stackTrace)?, LogType logLevel = LogType.info, int simultaneousProcessing = 1000000000})
- Creates a new ServerUniverseNative application.
Properties
- app → ServerUniverseNative
-
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- logWriter ↔ void Function(dynamic messageFn(), LogType type)
-
Writer to handle internal logging.
getter/setter pair
- onError ↔ (FutureOr Function(HttpRequest req, HttpResponse res, Object error, StackTrace stackTrace)?)
-
Optional handler for when the server throws an unhandled error
getter/setter pair
- onNotFound ↔ (FutureOr Function(HttpRequest req, HttpResponse res)?)
-
Optional handler for when a route is not found
getter/setter pair
- pathPrefix ↔ String
-
Optional path prefix to apply to all routes and route groups
getter/setter pairoverride
- requestQueue ↔ Queue
-
Incoming request queue
getter/setter pair
-
routes
→ List<
HttpRoute> -
List of routes
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- server ↔ HttpServer?
-
HttpServer instance from the dart:io library
getter/setter pair
-
typeHandlers
↔ List<
TypeHandler> -
An array of
TypeHandler
that ServerUniverseNative walks through in order to determine if it can handle a value returned from a route.getter/setter pair
Methods
-
addRoute(
HttpRoute route) → void -
all(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a route that listens on all methods
-
close(
{bool force = true}) → Future< void> - Close the server and clean up any resources
-
createRoute(
Method method, String path, FutureOr callback(HttpRequest req, HttpResponse res), [List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []]) → HttpRoute -
delete(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a delete route
-
ensureInitialized(
) → dynamic -
inherited
-
get(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a get route
-
head(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a head route
-
listen(
{int port = 3000, dynamic bindIp = '0.0.0.0', int backlog = 0}) → Future< HttpServer> -
Call this function to fire off the server.
override
-
listenSecure(
{required SecurityContext securityContext, int port = 3000, dynamic bindIp = '0.0.0.0', int backlog = 0}) → Future< HttpServer> -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
options(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create an options route
-
parsePattern(
String path) → String -
inherited
-
patch(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a patch route
-
post(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a post route
-
printRoutes(
) → void - Print out the registered routes to the console
-
put(
String path, FutureOr callback(HttpRequest req, HttpResponse res), {List< FutureOr Function(HttpRequest req, HttpResponse res)> middleware = const []}) → HttpRoute - Create a put route
-
registerOnDoneListener(
void listener(HttpRequest, HttpResponse)) → Function - Register a listener when a request is complete
-
removeOnDoneListener(
Function listener) → void - Dispose of any on done listeners when you are done with them.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited