Signals

Callback used by AuthDomainBasic for authentication purposes.

The application should verify that username and password and valid and return True or False.

If you are maintaining your own password database (rather than using the password to authenticate against some other system like PAM or a remote server), you should make sure you know what you are doing. In particular, don't store cleartext passwords, or easily-computed hashes of cleartext passwords, even if you don't care that much about the security of your server, because users will frequently use the same password for multiple sites, and so compromising any site with a cleartext (or easily-cracked) password database may give attackers access to other more-interesting sites as well.

Callback used by AuthDomainBasic for authentication purposes.

The application should verify that username and password and valid and return True or False.

If you are maintaining your own password database (rather than using the password to authenticate against some other system like PAM or a remote server), you should make sure you know what you are doing. In particular, don't store cleartext passwords, or easily-computed hashes of cleartext passwords, even if you don't care that much about the security of your server, because users will frequently use the same password for multiple sites, and so compromising any site with a cleartext (or easily-cracked) password database may give attackers access to other more-interesting sites as well.

Type for the callback on the (unwrapped) C side.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_AuthDomainBasicAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainBasicAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainBasicAuthCallback_WithClosures.

Wrap a AuthDomainBasicAuthCallback into a C_AuthDomainBasicAuthCallback.

Callback used by AuthDomainDigest for authentication purposes.

The application should look up username in its password database, and return the corresponding encoded password (see AuthDomainDigest.encode_password.

Callback used by AuthDomainDigest for authentication purposes.

The application should look up username in its password database, and return the corresponding encoded password (see AuthDomainDigest.encode_password.

Type for the callback on the (unwrapped) C side.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_AuthDomainDigestAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainDigestAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainDigestAuthCallback_WithClosures.

Wrap a AuthDomainDigestAuthCallback into a C_AuthDomainDigestAuthCallback.

The prototype for a AuthDomain filter.

See [methodauthDomain.set_filter] for details.

The prototype for a AuthDomain filter.

See [methodauthDomain.set_filter] for details.

Type for the callback on the (unwrapped) C side.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_AuthDomainFilter.

A convenience synonym for Nothing :: Maybe AuthDomainFilter.

A convenience synonym for Nothing :: Maybe AuthDomainFilter_WithClosures.

Wrap a AuthDomainFilter into a C_AuthDomainFilter.

The prototype for a AuthDomain generic authentication callback.

The callback should look up the user's password, call [methodauthDomain.check_password], and use the return value from that method as its own return value.

In general, for security reasons, it is preferable to use the auth-domain-specific auth callbacks (eg, [callbackauthDomainBasicAuthCallback] and [callbackauthDomainDigestAuthCallback]), because they don't require keeping a cleartext password database. Most users will use the same password for many different sites, meaning if any site with a cleartext password database is compromised, accounts on other servers might be compromised as well. For many of the cases where [classserver] is used, this is not really relevant, but it may still be worth considering.

The prototype for a AuthDomain generic authentication callback.

The callback should look up the user's password, call [methodauthDomain.check_password], and use the return value from that method as its own return value.

In general, for security reasons, it is preferable to use the auth-domain-specific auth callbacks (eg, [callbackauthDomainBasicAuthCallback] and [callbackauthDomainDigestAuthCallback]), because they don't require keeping a cleartext password database. Most users will use the same password for many different sites, meaning if any site with a cleartext password database is compromised, accounts on other servers might be compromised as well. For many of the cases where [classserver] is used, this is not really relevant, but it may still be worth considering.

Type for the callback on the (unwrapped) C side.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_AuthDomainGenericAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainGenericAuthCallback.

A convenience synonym for Nothing :: Maybe AuthDomainGenericAuthCallback_WithClosures.

Wrap a AuthDomainGenericAuthCallback into a C_AuthDomainGenericAuthCallback.

Type for the callback on the (unwrapped) C side.

The prototype for a logging filter.

The filter callback will be invoked for each request or response, and should analyze it and return a [enumloggerLogLevel] value indicating how much of the message to log.

The prototype for a logging filter.

The filter callback will be invoked for each request or response, and should analyze it and return a [enumloggerLogLevel] value indicating how much of the message to log.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_LoggerFilter.

A convenience synonym for Nothing :: Maybe LoggerFilter.

A convenience synonym for Nothing :: Maybe LoggerFilter_WithClosures.

Wrap a LoggerFilter into a C_LoggerFilter.

Type for the callback on the (unwrapped) C side.

The prototype for a custom printing callback.

level indicates what kind of information is being printed. Eg, it will be LoggerLogLevelHeaders if data is header data.

direction is either '<', '>', or ' ', and data is the single line to print; the printer is expected to add a terminating newline.

To get the effect of the default printer, you would do:

c code

printf ("%c %s\n", direction, data);

The prototype for a custom printing callback.

level indicates what kind of information is being printed. Eg, it will be LoggerLogLevelHeaders if data is header data.

direction is either '<', '>', or ' ', and data is the single line to print; the printer is expected to add a terminating newline.

To get the effect of the default printer, you would do:

c code

printf ("%c %s\n", direction, data);

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_LoggerPrinter.

A convenience synonym for Nothing :: Maybe LoggerPrinter.

A convenience synonym for Nothing :: Maybe LoggerPrinter_WithClosures.

Wrap a LoggerPrinter into a C_LoggerPrinter.

Type for the callback on the (unwrapped) C side.

The callback passed to [methodmessageHeaders.foreach].

The callback passed to [methodmessageHeaders.foreach].

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_MessageHeadersForeachFunc.

A convenience synonym for Nothing :: Maybe MessageHeadersForeachFunc.

A convenience synonym for Nothing :: Maybe MessageHeadersForeachFunc_WithClosures.

Wrap a MessageHeadersForeachFunc into a C_MessageHeadersForeachFunc.

Type for the callback on the (unwrapped) C side.

A callback used to handle requests to a [classserver].

path and query contain the likewise-named components of the Request-URI, subject to certain assumptions. By default, [classserver] decodes all percent-encoding in the URI path, such that "/foo%2Fbar" is treated the same as "/foo/bar". If your server is serving resources in some non-POSIX-filesystem namespace, you may want to distinguish those as two distinct paths. In that case, you can set the [propertyserver:raw-paths] property when creating the [classserver], and it will leave those characters undecoded.

query contains the query component of the Request-URI parsed according to the rules for HTML form handling. Although this is the only commonly-used query string format in HTTP, there is nothing that actually requires that HTTP URIs use that format; if your server needs to use some other format, you can just ignore query, and call [methodmessage.get_uri] and parse the URI's query field yourself.

See [methodserver.add_handler] and [methodserver.add_early_handler] for details of what handlers can/should do.

A callback used to handle requests to a [classserver].

path and query contain the likewise-named components of the Request-URI, subject to certain assumptions. By default, [classserver] decodes all percent-encoding in the URI path, such that "/foo%2Fbar" is treated the same as "/foo/bar". If your server is serving resources in some non-POSIX-filesystem namespace, you may want to distinguish those as two distinct paths. In that case, you can set the [propertyserver:raw-paths] property when creating the [classserver], and it will leave those characters undecoded.

query contains the query component of the Request-URI parsed according to the rules for HTML form handling. Although this is the only commonly-used query string format in HTTP, there is nothing that actually requires that HTTP URIs use that format; if your server needs to use some other format, you can just ignore query, and call [methodmessage.get_uri] and parse the URI's query field yourself.

See [methodserver.add_handler] and [methodserver.add_early_handler] for details of what handlers can/should do.

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ServerCallback.

A convenience synonym for Nothing :: Maybe ServerCallback.

A convenience synonym for Nothing :: Maybe ServerCallback_WithClosures.

Wrap a ServerCallback into a C_ServerCallback.

Type for the callback on the (unwrapped) C side.

A callback used to handle WebSocket requests to a Server.

The callback will be invoked after sending the handshake response back to the client (and is only invoked if the handshake was successful).

path contains the path of the Request-URI, subject to the same rules as [callbackserverCallback] (qv).

A callback used to handle WebSocket requests to a Server.

The callback will be invoked after sending the handshake response back to the client (and is only invoked if the handshake was successful).

path contains the path of the Request-URI, subject to the same rules as [callbackserverCallback] (qv).

A simple wrapper that ignores the closure arguments.

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ServerWebsocketCallback.

A convenience synonym for Nothing :: Maybe ServerWebsocketCallback.

A convenience synonym for Nothing :: Maybe ServerWebsocketCallback_WithClosures.

Wrap a ServerWebsocketCallback into a C_ServerWebsocketCallback.