Erl.Gun

data Protocol

Constructors

• Http (Record HttpOpts)
• Http2 (Record Http2Opts)
• Raw
• Socks (Record SocksOpts)

Instances

• ToErl Protocol

type HttpOpts :: Row Typetype HttpOpts = (closing_timeout :: Maybe Timeout, cookie_ignore_informational :: Maybe Boolean, flow :: Maybe PosInt, keepalive :: Maybe Timeout, transform_header_name :: Maybe TransformHeaderNameFn, version :: Maybe HttpVersion)

type Http2Opts :: Row Typetype Http2Opts = (connection_window_margin_size :: Maybe NonNegInt, connection_window_update_threshold :: Maybe NonNegInt, cookie_ignore_informational :: Maybe Boolean, enable_connect_protocol :: Maybe Boolean, flow :: Maybe PosInt, initial_connection_window_size :: Maybe PosInt, initial_stream_window_size :: Maybe NonNegInt, keepalive :: Maybe Timeout, losing_timeout :: Maybe Timeout, max_concurrent_streams :: Maybe IntOrInfinity, max_connection_window_size :: Maybe NonNegInt, max_decode_table_size :: Maybe NonNegInt, max_encode_table_size :: Maybe NonNegInt, max_frame_size_received :: Maybe PosInt, max_frame_size_sent :: Maybe IntOrInfinity, max_stream_buffer_size :: Maybe NonNegInt, max_stream_window_size :: Maybe NonNegInt, preface_timeout :: Maybe Timeout, settings_timeout :: Maybe Timeout, stream_window_margin_size :: Maybe NonNegInt, stream_window_update_threshold :: Maybe NonNegInt)

type SocksOpts :: Row Typetype SocksOpts = (auth :: Maybe SocksAuth, host :: Maybe HostAddress, port :: Maybe Port, protocols :: Maybe (List Protocol), tls_handshake_timeout :: Maybe Timeout, transport :: Maybe Transport, version :: Maybe PosInt)

data Transport

Constructors

• GunTcp (Record (ConnectOptions))
• GunTls (Record (ConnectOptions)) (Record (ClientOptions (CommonOptions ())))

Instances

• Show Transport
• Eq Transport
• OptionToErl "transport" Transport

data OptionToMaybe

Instances

• ConvertOption OptionToMaybe sym a (Maybe a)

data HttpVersion

Instances

• ToErl HttpVersion

data SocksAuth

Instances

• ToErl SocksAuth

newtype TransformHeaderNameFn

Instances

• ToErl TransformHeaderNameFn

data GunMessage

Constructors

• Gun_up ConnPid UpProtocol
• Gun_tunnel_up ConnPid StreamRef UpProtocol
• Gun_down ConnPid DownProtocol DownReason (List StreamRef)
• Gun_upgrade ConnPid StreamRef Foreign Headers
• Gun_error ConnPid StreamRef ErrorReason
• Gun_error2 ConnPid ErrorReason
• Gun_push ConnPid StreamRef StreamRef Method URI Headers
• Gun_inform ConnPid StreamRef Status Headers
• Gun_response ConnPid StreamRef Atom Status Headers
• Gun_data ConnPid StreamRef Atom Binary
• Gun_trailers ConnPid StreamRef Headers
• Gun_ws ConnPid StreamRef Frame

Instances

• RuntimeType GunMessage (RTOption (RTTuple3 (RTLiteralAtom "gun_up") RTWildcard RTWildcard) (RTOption (RTTuple4 (RTLiteralAtom "gun_tunnel_up") RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple5 (RTLiteralAtom "gun_down") RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple5 (RTLiteralAtom "gun_upgrade") RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple4 (RTLiteralAtom "gun_error") RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple3 (RTLiteralAtomConvert "gun_error" "gun_error2") RTWildcard RTWildcard) (RTOption (RTTuple7 (RTLiteralAtom "gun_push") RTWildcard RTWildcard RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple5 (RTLiteralAtom "gun_inform") RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple6 (RTLiteralAtom "gun_response") RTWildcard RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple5 (RTLiteralAtom "gun_data") RTWildcard RTWildcard RTWildcard RTWildcard) (RTOption (RTTuple4 (RTLiteralAtom "gun_trailers") RTWildcard RTWildcard RTWildcard) (RTTuple4 (RTLiteralAtom "gun_ws") RTWildcard RTWildcard RTWildcard))))))))))))

type ConnPid = Process Void

data DownProtocol

type DownReason = Foreign

type ErrorReason = Foreign

data StreamRef

Instances

• Eq StreamRef

data AwaitError

Constructors

• Stream_error Foreign
• Connection_error Foreign
• Down Foreign
• Timeout

data AwaitResponse

Constructors

• Inform Status Headers
• Response IsFin Status Headers
• Data IsFin Binary
• Trailers Trailers
• Push StreamRef Method URI Headers
• Upgrade Headers
• Ws Frame

data AwaitBodyResponse

Constructors

• Body Binary
• BodyWithTrailers Binary Trailers

data IsFin

Constructors

• Fin
• Nofin

data UpProtocol

Constructors

• UpHttp
• UpHttp2
• UpSocks

type Frame = Union |$| (Atom "close") |+| (Atom "ping") |+| (Atom "pong") |+| DataFrame |+| PingPongFrame |+| CloseFrame |+| Nil

data DataFrame

Constructors

• Text String
• Binary Binary
• Close Binary

Instances

• RuntimeType DataFrame (RTOption (RTTuple2 (RTLiteralAtom "text") RTWildcard) (RTOption (RTTuple2 (RTLiteralAtom "binary") RTWildcard) (RTTuple2 (RTLiteralAtom "close") RTWildcard)))

data CloseFrame

Constructors

• CloseFrame Status Binary

Instances

• RuntimeType CloseFrame (RTTuple3 (RTLiteralAtomConvert "close" "closeFrame") RTWildcard RTWildcard)

data PingPongFrame

Constructors

• Ping Binary
• Pong Binary

Instances

• RuntimeType PingPongFrame (RTOption (RTTuple2 (RTLiteralAtom "ping") RTWildcard) (RTTuple2 (RTLiteralAtom "pong") RTWildcard))

type Status = NonNegInt

type Headers = List Header

type Trailers = List Trailer

type Method = Binary

type URI = Binary

type Header = Tuple2 String String

type Trailer = Tuple2 String String

open :: forall options m msg. MonadEffect m => CanReceiveMessage GunMessage m => ConvertOptionsWithDefaults OptionToMaybe (Record Options) options (Record Options) => HostAddress -> Port -> options -> m (Either ErrorReason (ConnPid))

openUnix :: forall options m msg. MonadEffect m => CanReceiveMessage GunMessage m => ConvertOptionsWithDefaults OptionToMaybe (Record Options) options (Record Options) => String -> options -> m (Either ErrorReason (ConnPid))

setOwner :: forall msg. IsSupportedMessage GunMessage msg => ConnPid -> Process msg -> Effect Unit

shutdown :: ConnPid -> Effect Unit

close :: ConnPid -> Effect Unit

get :: ConnPid -> IOData -> Headers -> Effect StreamRef

head :: ConnPid -> IOData -> Headers -> Effect StreamRef

options :: ConnPid -> IOData -> Headers -> Effect StreamRef

patch :: ConnPid -> IOData -> Headers -> Effect StreamRef

patchWithBody :: ConnPid -> IOData -> Headers -> IOData -> Effect StreamRef

post :: ConnPid -> IOData -> Headers -> Effect StreamRef

postWithBody :: ConnPid -> IOData -> Headers -> IOData -> Effect StreamRef

put :: ConnPid -> IOData -> Headers -> Effect StreamRef

putWithBody :: ConnPid -> IOData -> Headers -> IOData -> Effect StreamRef

delete :: ConnPid -> IOData -> Headers -> Effect StreamRef

headers :: ConnPid -> Method -> IOData -> Headers -> Effect StreamRef

request :: ConnPid -> Method -> IOData -> Headers -> IOData -> Effect StreamRef

sendData :: ConnPid -> StreamRef -> IsFin -> IOData -> Effect StreamRef

await :: ConnPid -> StreamRef -> Timeout -> Effect (Either AwaitError AwaitResponse)

awaitBody :: ConnPid -> StreamRef -> Timeout -> Effect (Either AwaitError AwaitBodyResponse)

awaitUp :: ConnPid -> Timeout -> Effect (Either AwaitError UpProtocol)

flushConnection :: ConnPid -> Effect Unit

flushStream :: StreamRef -> Effect Unit

updateFlow :: ConnPid -> StreamRef -> PosInt -> Effect Unit

cancel :: ConnPid -> StreamRef -> Effect Unit

wsUpgrade :: ConnPid -> IOData -> Headers -> Effect StreamRef

wsSend :: ConnPid -> StreamRef -> List Frame -> Effect Unit

httpOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record HttpOpts) options (Record HttpOpts) => options -> Record HttpOpts

http2Options :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record Http2Opts) options (Record Http2Opts) => options -> Record Http2Opts

socksOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record SocksOpts) options (Record SocksOpts) => options -> Record SocksOpts

wsOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record WsOpts) options (Record WsOpts) => options -> Record WsOpts

tlsOptions :: forall options. ConvertOptionsWithDefaults OptionToMaybe (Record (ClientOptions (CommonOptions ()))) options (Record (ClientOptions (CommonOptions ()))) => options -> Record (ClientOptions (CommonOptions ()))

class OptionsToErl :: Row Type -> RowList Type -> Constraintclass OptionsToErl r rl  where

Members

• makeTerms :: Proxy rl -> Record r -> Map Atom Foreign

Instances

• OptionsToErl r Nil
• (IsSymbol sym, Cons sym (Maybe a) t1 r, OptionsToErl r tail, OptionToErl sym a) => OptionsToErl r (Cons sym (Maybe a) tail)
• (IsSymbol sym, Cons sym a t1 r, OptionsToErl r tail, OptionToErl sym a) => OptionsToErl r (Cons sym a tail)

optionsToErl :: forall r rl. RowToList r rl => OptionsToErl r rl => Record r -> Foreign

class OptionToErl :: Symbol -> Type -> Constraintclass OptionToErl sym option  where

Members

• optionToErl :: Map Atom Foreign -> Atom sym -> option -> Map Atom Foreign

Instances

• OptionToErl "transport" Transport
• (IsSymbol name, ToErl a) => OptionToErl name (List a)
• (IsSymbol name, RowToList r rl, OptionsToErl r rl) => OptionToErl name (Record r)
• (IsSymbol name, ToErl a) => OptionToErl name a