hunt-http ~master (2022-03-03T02:59:30Z)

HttpServer.Builder

hunt http server HttpServer HttpServer
class HttpServer
static final
class Builder {
enum PostMethod;
enum GetMethod;
enum PutMethod;
enum DeleteMethod;
this();
this(HttpServerOptions options);
Builder setListener(ushort port);
Builder setListener(ushort port, string host);
Builder ioThreadSize(uint value);
Builder workerThreadSize(uint value);
Builder canUpgrade(bool value);
Builder resourceCacheTime(Duration value);
Builder setCaCert(string caFile, string caPassword);
Builder setTLS(string certificate, string privateKey, string certPassword, string keyPassword);
Builder requiresClientAuth();
Builder setHandler(RoutingHandler handler);
Builder addRoute(string path, RoutingHandler handler);
Builder addRoute(string path, HttpMethod method, RoutingHandler handler);
Builder addRoute(string path, HttpMethod[] methods, RoutingHandler handler);
Builder addRoute(string[] paths, string[] methods, RoutingHandler handler, string groupName, RouteGroupType groupType, string attributeName, Object attributeObj);
Builder addRoute(string[] paths, string[] methods, RouteHandler handler, string groupName, RouteGroupType groupType, string attributeName, Object attributeObj);
Builder addRegexRoute(string regex, string[] methods, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder onGet(string path, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder onPost(string path, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder onPut(string path, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder onDelete(string path, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder onRequest(string method, string path, RoutingHandler handler, string groupName, RouteGroupType groupType);
Builder setDefaultRequest(RoutingHandler handler);
alias addNotFoundRoute = setDefaultRequest;
Builder resource(string path, string localPath, bool canList, string groupName, RouteGroupType groupType);
Builder resource(string path, AbstractResourceHandler handler, string groupName, RouteGroupType groupType);
Builder websocket(string path, WebSocketMessageHandler handler);
Builder enableLocalSessionStore();
Builder onError(BadRequestHandler handler);
version(WITH_HUNT_TRACE)
Builder localServiceName(string name);
version(WITH_HUNT_TRACE)
Builder isB3HeaderRequired(bool flag);
Builder maxRequestSize(int size);
Builder maxFileSize(int size);
HttpServer build();
}

Constructors

this
this()
Undocumented in source.
this
this(HttpServerOptions options)
Undocumented in source.

Members

Aliases

addNotFoundRoute
alias addNotFoundRoute = setDefaultRequest
Undocumented in source.

Functions

addRegexRoute
Builder addRegexRoute(string regex, string[] methods, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
addRoute
Builder addRoute(string path, RoutingHandler handler)

register a new router

addRoute
Builder addRoute(string path, HttpMethod method, RoutingHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
addRoute
Builder addRoute(string path, HttpMethod[] methods, RoutingHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
addRoute
Builder addRoute(string[] paths, string[] methods, RoutingHandler handler, string groupName, RouteGroupType groupType, string attributeName, Object attributeObj)
Undocumented in source. Be warned that the author may not have intended to support it.
addRoute
Builder addRoute(string[] paths, string[] methods, RouteHandler handler, string groupName, RouteGroupType groupType, string attributeName, Object attributeObj)
Undocumented in source. Be warned that the author may not have intended to support it.
build
HttpServer build()
Undocumented in source. Be warned that the author may not have intended to support it.
canUpgrade
Builder canUpgrade(bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
enableLocalSessionStore
Builder enableLocalSessionStore()
Undocumented in source. Be warned that the author may not have intended to support it.
ioThreadSize
Builder ioThreadSize(uint value)
Undocumented in source. Be warned that the author may not have intended to support it.
isB3HeaderRequired
Builder isB3HeaderRequired(bool flag)
Undocumented in source. Be warned that the author may not have intended to support it.
localServiceName
Builder localServiceName(string name)
Undocumented in source. Be warned that the author may not have intended to support it.
maxFileSize
Builder maxFileSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
maxRequestSize
Builder maxRequestSize(int size)
Undocumented in source. Be warned that the author may not have intended to support it.
onDelete
Builder onDelete(string path, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
onError
Builder onError(BadRequestHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
onGet
Builder onGet(string path, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
onPost
Builder onPost(string path, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
onPut
Builder onPut(string path, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
onRequest
Builder onRequest(string method, string path, RoutingHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
requiresClientAuth
Builder requiresClientAuth()
Undocumented in source. Be warned that the author may not have intended to support it.
resource
Builder resource(string path, string localPath, bool canList, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
resource
Builder resource(string path, AbstractResourceHandler handler, string groupName, RouteGroupType groupType)
Undocumented in source. Be warned that the author may not have intended to support it.
resourceCacheTime
Builder resourceCacheTime(Duration value)
Undocumented in source. Be warned that the author may not have intended to support it.
setCaCert
Builder setCaCert(string caFile, string caPassword)
Undocumented in source. Be warned that the author may not have intended to support it.
setDefaultRequest
Builder setDefaultRequest(RoutingHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
setHandler
Builder setHandler(RoutingHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
setListener
Builder setListener(ushort port)
Undocumented in source. Be warned that the author may not have intended to support it.
setListener
Builder setListener(ushort port, string host)
Undocumented in source. Be warned that the author may not have intended to support it.
setTLS
Builder setTLS(string certificate, string privateKey, string certPassword, string keyPassword)
Undocumented in source. Be warned that the author may not have intended to support it.
websocket
Builder websocket(string path, WebSocketMessageHandler handler)
Undocumented in source. Be warned that the author may not have intended to support it.
workerThreadSize
Builder workerThreadSize(uint value)
Undocumented in source. Be warned that the author may not have intended to support it.

Manifest constants

DeleteMethod
enum DeleteMethod;
Undocumented in source.
GetMethod
enum GetMethod;
Undocumented in source.
PostMethod
enum PostMethod;
Undocumented in source.
PutMethod
enum PutMethod;
Undocumented in source.

Meta

Source

See Implementation

hunt http server HttpServer HttpServer classesconstructorsfunctionsstatic functions

Page generated by adrdox