NgxExport

Nginx / Haskell interoperability layer and exporters of regular Haskell functions at Nginx level for using in configuration directives of nginx-haskell-module.

Type declarations

type ContentHandlerResult = (ByteString, ByteString, Int, HTTPHeaders)

The 4-tuple contains (content, content-type, HTTP-status, response-headers).

type UnsafeContentHandlerResult = (ByteString, ByteString, Int)

The 3-tuple contains (content, content-type, HTTP-status).

Both the content and the content-type are supposed to be referring to low-level string literals that do not need to be freed upon an HTTP request termination and must not be garbage-collected in the Haskell RTS.

type HTTPHeaders = [(ByteString, ByteString)]

A list of HTTP headers comprised of name-value pairs.

Exporters

Synchronous handlers

ngxExportSS :: Name -> Q [Dec]

Exports a function of type

String -> String

for using in directive haskell_run.

ngxExportSSS :: Name -> Q [Dec]

Exports a function of type

String -> String -> String

for using in directive haskell_run.

ngxExportSLS :: Name -> Q [Dec]

Exports a function of type

[String] -> String

for using in directive haskell_run.

ngxExportBS :: Name -> Q [Dec]

Exports a function of type

String -> Bool

for using in directive haskell_run.

ngxExportBSS :: Name -> Q [Dec]

Exports a function of type

String -> String -> Bool

for using in directive haskell_run.

ngxExportBLS :: Name -> Q [Dec]

Exports a function of type

[String] -> Bool

for using in directive haskell_run.

ngxExportYY :: Name -> Q [Dec]

Exports a function of type

ByteString -> ByteString

for using in directive haskell_run.

ngxExportBY :: Name -> Q [Dec]

Exports a function of type

ByteString -> Bool

for using in directive haskell_run.

ngxExportIOYY :: Name -> Q [Dec]

Exports a function of type

ByteString -> IO ByteString

for using in directive haskell_run.

Asynchronous handlers and services

ngxExportAsyncIOYY :: Name -> Q [Dec]

Exports a function of type

ByteString -> IO ByteString

for using in directive haskell_run_async.

ngxExportAsyncOnReqBody :: Name -> Q [Dec]

Exports a function of type

ByteString -> ByteString -> IO ByteString

for using in directive haskell_run_async_on_request_body.

The first argument of the exported function contains buffers of the client request body.

ngxExportServiceIOYY :: Name -> Q [Dec]

Exports a function of type

ByteString -> Bool -> IO ByteString

for using in directives haskell_run_service and haskell_service_var_update_callback.

The boolean argument of the exported function marks that the service is being run for the first time.

Content handlers

ngxExportHandler :: Name -> Q [Dec]

Exports a function of type

ByteString -> ContentHandlerResult

for using in directives haskell_content and haskell_static_content.

ngxExportDefHandler :: Name -> Q [Dec]

Exports a function of type

ByteString -> ByteString

for using in directives haskell_content and haskell_static_content.

ngxExportUnsafeHandler :: Name -> Q [Dec]

Exports a function of type

ByteString -> UnsafeContentHandlerResult

for using in directive haskell_unsafe_content.

ngxExportAsyncHandler :: Name -> Q [Dec]

Exports a function of type

ByteString -> IO ContentHandlerResult

for using in directive haskell_async_content.

ngxExportAsyncHandlerOnReqBody :: Name -> Q [Dec]

Exports a function of type

ByteString -> ByteString -> IO ContentHandlerResult

for using in directive haskell_async_content_on_request_body.

The first argument of the exported function contains buffers of the client request body.

Service hooks

ngxExportServiceHook :: Name -> Q [Dec]

Exports a function of type

ByteString -> IO ByteString

for using in directives haskell_service_hook and haskell_service_update_hook.

Accessing Nginx global objects

Opaque pointers

ngxCyclePtr :: IO (Ptr ())

Returns an opaque pointer to the Nginx cycle object for using it in C plugins.

The actual type of the returned pointer is

ngx_cycle_t *

(the value of argument cycle in the worker's initialization function).

ngxUpstreamMainConfPtr :: IO (Ptr ())

Returns an opaque pointer to the Nginx upstream main configuration for using it in C plugins.

The actual type of the returned pointer is

ngx_http_upstream_main_conf_t *

(the value of expression ngx_http_cycle_get_module_main_conf(cycle, ngx_http_upstream_module) in the worker's initialization function).

ngxCachedTimePtr :: IO (Ptr (Ptr ()))

Returns an opaque pointer to the Nginx cached time object for using it in C plugins.

The actual type of the returned pointer is

volatile ngx_time_t **

(the address of the Nginx global variable ngx_cached_time).

Be aware that time gotten from this pointer is not reliable in asynchronous tasks and services as soon as it gets updated only when some event happens inside the Nginx worker to which the task is bound and thus can be heavily outdated.

Primitive objects

ngxCachedPid :: IO CPid

Returns the PID of the current worker process cached in Nginx.

Since: 1.7.1

Accessing Nginx core functionality from Haskell handlers

newtype TerminateWorkerProcess

Terminates the worker process.

Being thrown from a service, this exception makes Nginx log the supplied message and terminate the worker process without respawning. This can be useful when the service is unable to read its configuration from the Nginx configuration script or to perform an important initialization action.

Since: 1.6.2

Constructors

TerminateWorkerProcess String

Contains the message to log

Instances

Exception TerminateWorkerProcess

Defined in NgxExport

Methods

toException :: TerminateWorkerProcess -> SomeException

fromException :: SomeException -> Maybe TerminateWorkerProcess

displayException :: TerminateWorkerProcess -> String

Show TerminateWorkerProcess

Defined in NgxExport

Methods

showsPrec :: Int -> TerminateWorkerProcess -> ShowS

show :: TerminateWorkerProcess -> String

showList :: [TerminateWorkerProcess] -> ShowS

Eq TerminateWorkerProcess

Defined in NgxExport

Methods

(==) :: TerminateWorkerProcess -> TerminateWorkerProcess -> Bool

(/=) :: TerminateWorkerProcess -> TerminateWorkerProcess -> Bool

newtype RestartWorkerProcess

Restarts the worker process.

The same as TerminateWorkerProcess, except that a new worker process shall be spawned by the Nginx master process in place of the current one.

Since: 1.6.3

Constructors

RestartWorkerProcess String

Contains the message to log

Instances

Exception RestartWorkerProcess

Defined in NgxExport

Methods

toException :: RestartWorkerProcess -> SomeException

fromException :: SomeException -> Maybe RestartWorkerProcess

displayException :: RestartWorkerProcess -> String

Show RestartWorkerProcess

Defined in NgxExport

Methods

showsPrec :: Int -> RestartWorkerProcess -> ShowS

show :: RestartWorkerProcess -> String

showList :: [RestartWorkerProcess] -> ShowS

Eq RestartWorkerProcess

Defined in NgxExport

Methods

(==) :: RestartWorkerProcess -> RestartWorkerProcess -> Bool

(/=) :: RestartWorkerProcess -> RestartWorkerProcess -> Bool

data WorkerProcessIsExiting

Signals that the worker process is exiting.

This asynchronous exception is thrown from the Nginx core to all services with cancelWith when the working process is exiting. An exception handler that catches this exception is expected to perform the service's specific cleanup and finalization actions.

Since: 1.6.4

Instances

Exception WorkerProcessIsExiting

Defined in NgxExport

Methods

toException :: WorkerProcessIsExiting -> SomeException

fromException :: SomeException -> Maybe WorkerProcessIsExiting

displayException :: WorkerProcessIsExiting -> String

Show WorkerProcessIsExiting

Defined in NgxExport

Methods

showsPrec :: Int -> WorkerProcessIsExiting -> ShowS

show :: WorkerProcessIsExiting -> String

showList :: [WorkerProcessIsExiting] -> ShowS

Eq WorkerProcessIsExiting

Defined in NgxExport

Methods

(==) :: WorkerProcessIsExiting -> WorkerProcessIsExiting -> Bool

(/=) :: WorkerProcessIsExiting -> WorkerProcessIsExiting -> Bool

data FinalizeHTTPRequest

Finalizes the HTTP request.

Being thrown from an asynchronous variable handler, this exception makes Nginx finalize the current HTTP request with the supplied HTTP status and an optional body. If the body is Nothing then the response will be styled by the Nginx core.

Since: 1.6.3

Constructors

FinalizeHTTPRequest Int (Maybe String)

Contains HTTP status and body

Instances

Exception FinalizeHTTPRequest

Defined in NgxExport

Methods

toException :: FinalizeHTTPRequest -> SomeException

fromException :: SomeException -> Maybe FinalizeHTTPRequest

displayException :: FinalizeHTTPRequest -> String

Show FinalizeHTTPRequest

Defined in NgxExport

Methods

showsPrec :: Int -> FinalizeHTTPRequest -> ShowS

show :: FinalizeHTTPRequest -> String

showList :: [FinalizeHTTPRequest] -> ShowS

Eq FinalizeHTTPRequest

Defined in NgxExport

Methods

(==) :: FinalizeHTTPRequest -> FinalizeHTTPRequest -> Bool

(/=) :: FinalizeHTTPRequest -> FinalizeHTTPRequest -> Bool

Re-exported data constructors from Foreign.C

Re-exports are needed by exporters for marshalling in foreign calls.

newtype CInt

Haskell type representing the C int type. (The concrete types of Foreign.C.Types are platform-specific.)

Constructors

CInt Int32

Instances

Storable CInt

Defined in Foreign.C.Types

Methods

sizeOf :: CInt -> Int

alignment :: CInt -> Int

peekElemOff :: Ptr CInt -> Int -> IO CInt

pokeElemOff :: Ptr CInt -> Int -> CInt -> IO ()

peekByteOff :: Ptr b -> Int -> IO CInt

pokeByteOff :: Ptr b -> Int -> CInt -> IO ()

peek :: Ptr CInt -> IO CInt

poke :: Ptr CInt -> CInt -> IO ()

Bits CInt

Defined in Foreign.C.Types

Methods

(.&.) :: CInt -> CInt -> CInt

(.|.) :: CInt -> CInt -> CInt

xor :: CInt -> CInt -> CInt

complement :: CInt -> CInt

shift :: CInt -> Int -> CInt

rotate :: CInt -> Int -> CInt

zeroBits :: CInt

bit :: Int -> CInt

setBit :: CInt -> Int -> CInt

clearBit :: CInt -> Int -> CInt

complementBit :: CInt -> Int -> CInt

testBit :: CInt -> Int -> Bool

bitSizeMaybe :: CInt -> Maybe Int

bitSize :: CInt -> Int

isSigned :: CInt -> Bool

shiftL :: CInt -> Int -> CInt

unsafeShiftL :: CInt -> Int -> CInt

shiftR :: CInt -> Int -> CInt

unsafeShiftR :: CInt -> Int -> CInt

rotateL :: CInt -> Int -> CInt

rotateR :: CInt -> Int -> CInt

popCount :: CInt -> Int

FiniteBits CInt

Defined in Foreign.C.Types

Methods

finiteBitSize :: CInt -> Int

countLeadingZeros :: CInt -> Int

countTrailingZeros :: CInt -> Int

Bounded CInt

Defined in Foreign.C.Types

Methods

minBound :: CInt

maxBound :: CInt

Enum CInt

Defined in Foreign.C.Types

Methods

succ :: CInt -> CInt

pred :: CInt -> CInt

toEnum :: Int -> CInt

fromEnum :: CInt -> Int

enumFrom :: CInt -> [CInt]

enumFromThen :: CInt -> CInt -> [CInt]

enumFromTo :: CInt -> CInt -> [CInt]

enumFromThenTo :: CInt -> CInt -> CInt -> [CInt]

Ix CInt

Defined in Foreign.C.Types

Methods

range :: (CInt, CInt) -> [CInt]

index :: (CInt, CInt) -> CInt -> Int

unsafeIndex :: (CInt, CInt) -> CInt -> Int

inRange :: (CInt, CInt) -> CInt -> Bool

rangeSize :: (CInt, CInt) -> Int

unsafeRangeSize :: (CInt, CInt) -> Int

Num CInt

Defined in Foreign.C.Types

Methods

(+) :: CInt -> CInt -> CInt

(-) :: CInt -> CInt -> CInt

(*) :: CInt -> CInt -> CInt

negate :: CInt -> CInt

abs :: CInt -> CInt

signum :: CInt -> CInt

fromInteger :: Integer -> CInt

Read CInt

Defined in Foreign.C.Types

Methods

readsPrec :: Int -> ReadS CInt

readList :: ReadS [CInt]

readPrec :: ReadPrec CInt

readListPrec :: ReadPrec [CInt]

Integral CInt

Defined in Foreign.C.Types

Methods

quot :: CInt -> CInt -> CInt

rem :: CInt -> CInt -> CInt

div :: CInt -> CInt -> CInt

mod :: CInt -> CInt -> CInt

quotRem :: CInt -> CInt -> (CInt, CInt)

divMod :: CInt -> CInt -> (CInt, CInt)

toInteger :: CInt -> Integer

Real CInt

Defined in Foreign.C.Types

Methods

toRational :: CInt -> Rational

Show CInt

Defined in Foreign.C.Types

Methods

showsPrec :: Int -> CInt -> ShowS

show :: CInt -> String

showList :: [CInt] -> ShowS

NFData CInt

Since: deepseq-1.4.0.0

Defined in Control.DeepSeq

Methods

rnf :: CInt -> ()

Eq CInt

Defined in Foreign.C.Types

Methods

(==) :: CInt -> CInt -> Bool

(/=) :: CInt -> CInt -> Bool

Ord CInt

Defined in Foreign.C.Types

Methods

compare :: CInt -> CInt -> Ordering

(<) :: CInt -> CInt -> Bool

(<=) :: CInt -> CInt -> Bool

(>) :: CInt -> CInt -> Bool

(>=) :: CInt -> CInt -> Bool

max :: CInt -> CInt -> CInt

min :: CInt -> CInt -> CInt

newtype CUInt

Haskell type representing the C unsigned int type. (The concrete types of Foreign.C.Types are platform-specific.)

Constructors

CUInt Word32

Instances

Storable CUInt

Defined in Foreign.C.Types

Methods

sizeOf :: CUInt -> Int

alignment :: CUInt -> Int

peekElemOff :: Ptr CUInt -> Int -> IO CUInt

pokeElemOff :: Ptr CUInt -> Int -> CUInt -> IO ()

peekByteOff :: Ptr b -> Int -> IO CUInt

pokeByteOff :: Ptr b -> Int -> CUInt -> IO ()

peek :: Ptr CUInt -> IO CUInt

poke :: Ptr CUInt -> CUInt -> IO ()

Bits CUInt

Defined in Foreign.C.Types

Methods

(.&.) :: CUInt -> CUInt -> CUInt

(.|.) :: CUInt -> CUInt -> CUInt

xor :: CUInt -> CUInt -> CUInt

complement :: CUInt -> CUInt

shift :: CUInt -> Int -> CUInt

rotate :: CUInt -> Int -> CUInt

zeroBits :: CUInt

bit :: Int -> CUInt

setBit :: CUInt -> Int -> CUInt

clearBit :: CUInt -> Int -> CUInt

complementBit :: CUInt -> Int -> CUInt

testBit :: CUInt -> Int -> Bool

bitSizeMaybe :: CUInt -> Maybe Int

bitSize :: CUInt -> Int

isSigned :: CUInt -> Bool

shiftL :: CUInt -> Int -> CUInt

unsafeShiftL :: CUInt -> Int -> CUInt

shiftR :: CUInt -> Int -> CUInt

unsafeShiftR :: CUInt -> Int -> CUInt

rotateL :: CUInt -> Int -> CUInt

rotateR :: CUInt -> Int -> CUInt

popCount :: CUInt -> Int

FiniteBits CUInt

Defined in Foreign.C.Types

Methods

finiteBitSize :: CUInt -> Int

countLeadingZeros :: CUInt -> Int

countTrailingZeros :: CUInt -> Int

Bounded CUInt

Defined in Foreign.C.Types

Methods

minBound :: CUInt

maxBound :: CUInt

Enum CUInt

Defined in Foreign.C.Types

Methods

succ :: CUInt -> CUInt

pred :: CUInt -> CUInt

toEnum :: Int -> CUInt

fromEnum :: CUInt -> Int

enumFrom :: CUInt -> [CUInt]

enumFromThen :: CUInt -> CUInt -> [CUInt]

enumFromTo :: CUInt -> CUInt -> [CUInt]

enumFromThenTo :: CUInt -> CUInt -> CUInt -> [CUInt]

Ix CUInt

Defined in Foreign.C.Types

Methods

range :: (CUInt, CUInt) -> [CUInt]

index :: (CUInt, CUInt) -> CUInt -> Int

unsafeIndex :: (CUInt, CUInt) -> CUInt -> Int

inRange :: (CUInt, CUInt) -> CUInt -> Bool

rangeSize :: (CUInt, CUInt) -> Int

unsafeRangeSize :: (CUInt, CUInt) -> Int

Num CUInt

Defined in Foreign.C.Types

Methods

(+) :: CUInt -> CUInt -> CUInt

(-) :: CUInt -> CUInt -> CUInt

(*) :: CUInt -> CUInt -> CUInt

negate :: CUInt -> CUInt

abs :: CUInt -> CUInt

signum :: CUInt -> CUInt

fromInteger :: Integer -> CUInt

Read CUInt

Defined in Foreign.C.Types

Methods

readsPrec :: Int -> ReadS CUInt

readList :: ReadS [CUInt]

readPrec :: ReadPrec CUInt

readListPrec :: ReadPrec [CUInt]

Integral CUInt

Defined in Foreign.C.Types

Methods

quot :: CUInt -> CUInt -> CUInt

rem :: CUInt -> CUInt -> CUInt

div :: CUInt -> CUInt -> CUInt

mod :: CUInt -> CUInt -> CUInt

quotRem :: CUInt -> CUInt -> (CUInt, CUInt)

divMod :: CUInt -> CUInt -> (CUInt, CUInt)

toInteger :: CUInt -> Integer

Real CUInt

Defined in Foreign.C.Types

Methods

toRational :: CUInt -> Rational

Show CUInt

Defined in Foreign.C.Types

Methods

showsPrec :: Int -> CUInt -> ShowS

show :: CUInt -> String

showList :: [CUInt] -> ShowS

NFData CUInt

Since: deepseq-1.4.0.0

Defined in Control.DeepSeq

Methods

rnf :: CUInt -> ()

Eq CUInt

Defined in Foreign.C.Types

Methods

(==) :: CUInt -> CUInt -> Bool

(/=) :: CUInt -> CUInt -> Bool

Ord CUInt

Defined in Foreign.C.Types

Methods

compare :: CUInt -> CUInt -> Ordering

(<) :: CUInt -> CUInt -> Bool

(<=) :: CUInt -> CUInt -> Bool

(>) :: CUInt -> CUInt -> Bool

(>=) :: CUInt -> CUInt -> Bool

max :: CUInt -> CUInt -> CUInt

min :: CUInt -> CUInt -> CUInt