Erl.Kernel.Inet

data ActiveError

Constructors

• ActiveClosed
• ActiveTimeout
• ActivePosix PosixError

Instances

• Eq ActiveError
• Generic ActiveError _
• Show ActiveError

data ActiveSocket :: SocketMessageBehaviourdata ActiveSocket

Instances

• OptionsValid ActiveSocket options

data AddressFamily

Constructors

• Inet4
• Inet6
• Local

Instances

• Eq AddressFamily
• ToErl AddressFamily

type CommonOptions :: Row Type -> Row Typetype CommonOptions r = (active :: Maybe SocketActive, buffer :: Maybe NonNegInt, dontroute :: Maybe Boolean, header :: Maybe NonNegInt, high_msgq_watermark :: Maybe NonNegInt, ipv6_v6only :: Maybe Boolean, low_msgq_watermark :: Maybe NonNegInt, priority :: Maybe Int, raw :: Maybe (List Raw), recbuf :: Maybe NonNegInt, recvtclass :: Maybe Boolean, recvtos :: Maybe Boolean, recvttl :: Maybe Boolean, reuseaddr :: Maybe Boolean, sndbuf :: Maybe NonNegInt, tclass :: Maybe NonNegInt, tos :: Maybe Int, ttl :: Maybe NonNegInt | r)

data ConnectAddress

Constructors

• SocketAddr SocketAddress
• HostAddr HostAddress

Instances

• ToErl ConnectAddress

data ConnectError

Constructors

• ConnectTimeout
• ConnectPosix PosixError

Instances

• Eq ConnectError
• Generic ConnectError _
• Show ConnectError

data ConnectedSocket :: SocketTypedata ConnectedSocket

data HostAddress

Constructors

• Host Hostname
• Ip IpAddress

Instances

• Eq HostAddress
• Generic HostAddress _
• Show HostAddress
• ToErl HostAddress

type Hostname = String

type InterfaceAddressRecord ipType = { address :: ipType, broadcastAddress :: Maybe Ip4Address, dstAddress :: Maybe Ip4Address, netmask :: ipType }

data InterfaceAddresses

Constructors

• Ip4InterfaceAddresses (InterfaceAddressRecord Ip4Address)
• Ip6InterfaceAddresses (InterfaceAddressRecord Ip6Address)

data InterfaceFlags

Constructors

• IfUp
• IfBroadcast
• IfLoopback
• IfPointToPoint
• IfRunning
• IfMulticast

type InterfaceName = Atom

newtype InterfaceOptions

Constructors

• InterfaceOptions { addresses :: Maybe InterfaceAddresses, flags :: List InterfaceFlags, hwAddress :: Binary }

newtype Ip4Address

Constructors

• Ip4Address (Tuple4 Octet Octet Octet Octet)

Instances

• Eq Ip4Address
• Generic Ip4Address _
• Show Ip4Address
• Newtype Ip4Address _
• RuntimeType Ip4Address (RTTuple4 RTInt RTInt RTInt RTInt)
• ToErl Ip4Address

newtype Ip6Address

Constructors

• Ip6Address (Tuple8 Hextet Hextet Hextet Hextet Hextet Hextet Hextet Hextet)

Instances

• Eq Ip6Address
• Generic Ip6Address _
• Show Ip6Address
• Newtype Ip6Address _
• RuntimeType Ip6Address (RTTuple8 RTInt RTInt RTInt RTInt RTInt RTInt RTInt RTInt)
• ToErl Ip6Address

data IpAddress

Constructors

• Ip4 Ip4Address
• Ip6 Ip6Address

Instances

• Eq IpAddress
• Generic IpAddress _
• Show IpAddress
• ToErl IpAddress

type IpAddressUnion = Union (Ip4Address |+| Ip6Address |+| Nil)

data ListenSocket :: SocketTypedata ListenSocket

type LocalAddress = String

data PassiveSocket :: SocketMessageBehaviourdata PassiveSocket

Instances

• (Lacks "active" options) => OptionsValid PassiveSocket options

newtype Port

Constructors

• Port Int

Instances

• Eq Port
• Generic Port _
• Show Port
• Newtype Port _
• RuntimeType Port RTInt
• ToErl Port

data PosixError

Constructors

• EAddrinuse
• EAddrnotavail
• EAfnosupport
• EAlready
• EConnaborted
• EConnrefused
• EConnreset
• EDestaddrreq
• EHostdown
• EHostunreach
• EInprogress
• EIsconn
• EMsgsize
• ENetdown
• ENetunreach
• ENopkg
• ENoprotoopt
• ENotconn
• ENotty
• ENotsock
• EProto
• EProtonosupport
• EPrototype
• ESocktnosupport
• ETimedout
• EWouldblock
• EXbadport
• EXbadseq
• File PosixError

Instances

• Eq PosixError
• Show PosixError

data Raw

Constructors

• Raw NonNegInt NonNegInt Binary

Instances

• Eq Raw
• ToErl Raw
• OptionToErl "raw" (List Raw)

data SendError

Constructors

• SendClosed
• SendPosix PosixError

Instances

• Eq SendError
• Generic SendError _
• Show SendError

data SocketActive

Constructors

• Active
• Passive
• Once
• N Int

Instances

• Eq SocketActive
• ToErl SocketActive

data SocketAddress

Constructors

• IpAddress IpAddress
• Any
• Loopback
• LocalAddress LocalAddress

Instances

• Eq SocketAddress
• ToErl SocketAddress

data SocketMessageBehaviour

data SocketMode

Constructors

• ListData
• BinaryData

Instances

• Eq SocketMode
• ToErl SocketMode

data SocketType

activeErrorToPurs :: Foreign -> Maybe ActiveError

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

Members

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

Instances

• OptionToErl "raw" (List Raw)
• (IsSymbol name, ToErl a) => OptionToErl name (List a)
• (IsSymbol name, ToErl a) => OptionToErl name a

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

Members

• makeTerms :: Proxy rl -> Record r -> List 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)

class OptionsValid :: SocketMessageBehaviour -> Row Type -> Constraintclass OptionsValid socketMessageBehaviour options 

Instances

• OptionsValid ActiveSocket options
• (Lacks "active" options) => OptionsValid PassiveSocket options

class Socket socket  where

Members

• send :: socket -> IOData -> Effect (Either SendError Unit)
• recv :: socket -> NonNegInt -> Timeout -> Effect (Either ActiveError Binary)
• close :: socket -> Effect Unit

connectErrorToPurs :: Foreign -> Maybe ConnectError

connectIp4Any :: ConnectAddress

connectIp4Loopback :: ConnectAddress

connectIp6Any :: ConnectAddress

connectIp6Loopback :: ConnectAddress

defaultCommonOptions :: forall r. Union r (CommonOptions ()) (CommonOptions r) => Record r -> Record (CommonOptions r)

getIfAddresses :: Effect (Either PosixError (Map InterfaceName (List InterfaceOptions)))

getIp4IfAddresses :: InterfaceName -> Effect (List Ip4Address)

ip4 :: Int -> Int -> Int -> Int -> Maybe Ip4Address

ip4Any :: Ip4Address

ip4Loopback :: Ip4Address

ip6 :: Int -> Int -> Int -> Int -> Int -> Int -> Int -> Int -> Maybe Ip6Address

ip6Any :: Ip6Address

ip6Loopback :: Ip6Address

ipMulticastAll :: Boolean -> Raw

isMulticast :: IpAddress -> Boolean

macOsSoReusePort :: Boolean -> Raw

ntoa :: IpAddress -> String

ntoa4 :: Ip4Address -> String

ntoa6 :: Ip6Address -> String

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

parseIp4Address :: String -> Maybe Ip4Address

parseIp6Address :: String -> Maybe Ip6Address

parseIpAddress :: String -> Maybe IpAddress

posixErrorToPurs :: Foreign -> Maybe PosixError

sendErrorToPurs :: Foreign -> Maybe SendError

windowsSoReuseAddr :: Boolean -> Raw