Module

Erl.Gun

Package: erl-gun
Repository: id3as/purescript-erl-gun

#Protocol Source

data Protocol

Constructors

Instances

ToErl Protocol

#HttpOpts Source

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)

#Http2Opts Source

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)

#SocksOpts Source

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)

#Transport Source

data Transport

Constructors

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

Instances

#OptionToMaybe Source

data OptionToMaybe

Instances

ConvertOption OptionToMaybe sym a (Maybe a)

#HttpVersion Source

data HttpVersion

Instances

ToErl HttpVersion

#SocksAuth Source

data SocksAuth

Instances

ToErl SocksAuth

#TransformHeaderNameFn Source

newtype TransformHeaderNameFn

Instances

ToErl TransformHeaderNameFn

#GunMessage Source

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))))))))))))

#ConnPid Source

type ConnPid = Process Void

#DownProtocol Source

data DownProtocol

#DownReason Source

type DownReason = Foreign

#ErrorReason Source

type ErrorReason = Foreign

#StreamRef Source

data StreamRef :: Type

Instances

Eq StreamRef

#AwaitError Source

data AwaitError

Constructors

#AwaitResponse Source

data AwaitResponse

Constructors

#AwaitBodyResponse Source

data AwaitBodyResponse

Constructors

Body Binary
BodyWithTrailers Binary Trailers

#IsFin Source

data IsFin

Constructors

Fin
Nofin

#UpProtocol Source

data UpProtocol

Constructors

#Frame Source

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

#DataFrame Source

data DataFrame

Constructors

Instances

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

#CloseFrame Source

data CloseFrame

Constructors

CloseFrame Status Binary

Instances

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

#PingPongFrame Source

data PingPongFrame

Constructors

Ping Binary
Pong Binary

Instances

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

#Status Source

type Status = NonNegInt

#Headers Source

type Headers = List Header

#Trailers Source

type Trailers = List Trailer

#Method Source

type Method = Binary

#URI Source

type URI = Binary

#Trailer Source

type Trailer = Tuple2 String String

#open Source

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

#openUnix Source

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

#setOwner Source

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

#shutdown Source

shutdown :: ConnPid -> Effect Unit

#close Source

close :: ConnPid -> Effect Unit

#get Source

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

#head Source

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

#options Source

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

#patch Source

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

#patchWithBody Source

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

#post Source

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

#postWithBody Source

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

#put Source

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

#putWithBody Source

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

#delete Source

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

#headers Source

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

#request Source

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

#sendData Source

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

#await Source

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

#awaitBody Source

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

#awaitUp Source

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

#flushConnection Source

flushConnection :: ConnPid -> Effect Unit

#flushStream Source

flushStream :: StreamRef -> Effect Unit

#updateFlow Source

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

#cancel Source

cancel :: ConnPid -> StreamRef -> Effect Unit

#wsUpgrade Source

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

#wsSend Source

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

#httpOptions Source

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

#http2Options Source

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

#socksOptions Source

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

#wsOptions Source

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

#tlsOptions Source

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

#OptionsToErl Source

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 Source

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

#OptionToErl Source

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

Modules: Erl.Gun; Erl.Gun.WsGun

Erl.Gun

#Protocol Source

Constructors

Instances

#HttpOpts Source

#Http2Opts Source

#SocksOpts Source

#Transport Source

Constructors

Instances

#OptionToMaybe Source

Instances

#HttpVersion Source

Instances

#SocksAuth Source

Instances

#TransformHeaderNameFn Source

Instances

#GunMessage Source

Constructors

Instances

#ConnPid Source

#DownProtocol Source

#DownReason Source

#ErrorReason Source

#StreamRef Source

Instances

#AwaitError Source

Constructors

#AwaitResponse Source

Constructors

#AwaitBodyResponse Source

Constructors

#IsFin Source

Constructors

#UpProtocol Source

Constructors

#Frame Source

#DataFrame Source

Constructors

Instances

#CloseFrame Source

Constructors

Instances

#PingPongFrame Source

Constructors

Instances

#Status Source

#Headers Source

#Trailers Source

#Method Source

#URI Source

#Header Source

#Trailer Source

#open Source

#openUnix Source

#setOwner Source

#shutdown Source

#close Source

#get Source

#head Source

#options Source

#patch Source

#patchWithBody Source

#post Source

#postWithBody Source

#put Source

#putWithBody Source

#delete Source

#headers Source

#request Source

#sendData Source

#await Source

#awaitBody Source

#awaitUp Source

#flushConnection Source

#flushStream Source

#updateFlow Source

#cancel Source

#wsUpgrade Source