Safe Haskell | None |
---|---|
Language | Haskell2010 |
Configuration and settings for the server. All constructor names are exported, but notice that they start with an underscore. They also have an equivalent lens without the underscore. Please prefer to use the lens interface.
- sessionId :: Functor f => (Int -> f Int) -> SessionCoordinates -> f SessionCoordinates
- defaultSessionsConfig :: SessionsConfig
- defaultSessionsEnrichedHeaders :: SessionsEnrichedHeaders
- sessionsCallbacks :: Lens' SessionsConfig SessionsCallbacks
- sessionsEnrichedHeaders :: Lens' SessionsConfig SessionsEnrichedHeaders
- reportErrorCallback_SC :: Lens' SessionsCallbacks (Maybe ErrorCallback)
- dataDeliveryCallback_SC :: Lens' SessionsCallbacks (Maybe DataFrameDeliveryCallback)
- dataFrameSize :: Lens' SessionsConfig Int
- addUsedProtocol :: Iso' SessionsEnrichedHeaders Bool
- data SessionComponent
- newtype SessionCoordinates = SessionCoordinates Int
- data SessionsCallbacks = SessionsCallbacks {}
- data SessionsEnrichedHeaders = SessionsEnrichedHeaders {}
- data SessionsConfig = SessionsConfig {}
- type ErrorCallback = (SessionComponent, SessionCoordinates, SomeException) -> IO ()
- type DataFrameDeliveryCallback = Int -> Int -> Int -> TimeSpec -> IO ()
Documentation
sessionId :: Functor f => (Int -> f Int) -> SessionCoordinates -> f SessionCoordinates
Get/set a numeric Id from a SessionCoordinates
. For example, to
get the session id with this, import `Control.Lens.(^.)` and then do
session_id = session_coordinates ^. sessionId
defaultSessionsConfig :: SessionsConfig
Creates a default sessions context. Modify as needed using the lenses interfaces
defaultSessionsEnrichedHeaders :: SessionsEnrichedHeaders
Don't insert any extra-headers by default.
data SessionComponent
Components at an individual session. Used to report where in the session an error was produced. This interface is likely to change in the future, as we add more metadata to exceptions
newtype SessionCoordinates
Information used to identify a particular session.
data SessionsCallbacks
Callbacks that you can provide your sessions to notify you of interesting things happening in the server.
This is a temporal interface, but an useful one nonetheless. By setting some values here to True, second-transfer will add some headers to inbound requests, and some headers to outbound requests.
This interface is deprecated in favor of the AwareWorker functionality....
SessionsEnrichedHeaders | |
|
data SessionsConfig
Configuration information you can provide to the session maker.
SessionsConfig | |
|
type ErrorCallback = (SessionComponent, SessionCoordinates, SomeException) -> IO ()
Used by this session engine to report an error at some component, in a particular session.