Modulevortex-ws-0.2.1GHC2024

Vortex.Ws.Door.Types

The values a door's settings speak, and the DoorSettings a settings program folds to.

Contents

Names
Measures
Statements and the settings they fold to

Synopsis

newtype Origin
value fromOrigin
value mkOrigin
data Rate
data Statement
value statementVerb
data DoorSettings
data SettingsError
value settingsErrorText
value lawful

Packagevortex-ws-0.2.1
Exports10
LanguageGHC2024
LicenceBSD-3-Clause
SourceTypes.hs

Names

newtypenewtype Origin

Source#

A page a browser may open the door from: https:// or http://, a lower-case host and an optional port, exactly as a browser sends it in Origin.

Instances4Eq, Ord, Show, IsString

Eq OriginDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Ord OriginDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Show OriginDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
IsString OriginDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types

valuefromOrigin :: Origin -> Text

valuemkOrigin :: Text -> Maybe Origin

Measures

datadata Rate

Source#

A token bucket's shape: how many frames may arrive at once, and how many more each second.

Constructors

MkRate
- rateBurst :: Double
- ratePerSecond :: Double

Instances3Eq, Read, Show

Eq RateDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Read RateDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Show RateDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types

Statements and the settings they fold to

datadata Statement

Source#

One thing a settings program says. The settled form of a program is the Show of its statements, folded again when it is read back.

Constructors

Instances3Eq, Read, Show

Eq StatementDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Read StatementDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Show StatementDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types

valuestatementVerb :: Statement -> String

datadata DoorSettings

Source#

Everything the door holds a connection to before and while it is a session.

Constructors

MkDoorSettings
- doorOrigins :: [Origin]
  The pages a handshake may come from; any other is refused, 403.
- doorHandshake :: Int
  Seconds a connection has to finish its opening handshake.
- doorFrameBytes :: Int
  The largest frame, and the largest message; more ends the connection.
- doorPing :: Int
  Seconds between pings, which keep an idle connection alive through a proxy.
- doorSessions :: Int
  Sessions open at once; one more is refused, 503.
- doorSessionsPerPeer :: Int
  Sessions open at once from one peer.
- doorPeerRate :: Rate
  Each peer's frames.
- doorOverallRate :: Rate
  Every peer's frames together.

Instances2Eq, Show

Eq DoorSettingsDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Show DoorSettingsDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types

datadata SettingsError

Source#

Why a program declares no settings.

Constructors

Instances2Eq, Show

Eq SettingsErrorDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types
Show SettingsErrorDefined in vortex-ws-0.2.1 · Vortex.Ws.Door.Types

valuesettingsErrorText :: SettingsError -> String

valuelawful :: DoorSettings -> Either SettingsError DoorSettings

Source#

The laws a door's settings keep: every measure positive and bounded, no more sessions from one peer than from all, and a bucket that can hold a frame.