Erl.Kernel.Udp

type Options :: Row Type -> Row Typetype Options r = CommonOptions (add_membership :: Maybe (Tuple2 IpAddress IpAddress), broadcast :: Maybe Boolean, drop_membership :: Maybe (Tuple2 IpAddress IpAddress), multicast_if :: Maybe IpAddress, multicast_loop :: Maybe Boolean, multicast_ttl :: Maybe NonNegInt, read_packets :: Maybe NonNegInt | r)

type OpenOptions :: Row Typetype OpenOptions = Options (bind_to_device :: Maybe Binary, family :: Maybe AddressFamily, fd :: Maybe NonNegInt, ifaddr :: Maybe SocketAddress, ip :: Maybe SocketAddress, netns :: Maybe FileName, port :: Maybe Port)

data UdpSocket :: SocketMessageBehaviour -> Typedata UdpSocket t0

Instances

• Eq (UdpSocket ActiveSocket)
• Eq (UdpSocket PassiveSocket)
• Show (UdpSocket ActiveSocket)
• Show (UdpSocket PassiveSocket)

data UdpMessage

Constructors

• Udp (UdpSocket ActiveSocket) IpAddressUnion Port Binary
• UdpAnc (UdpSocket ActiveSocket) IpAddressUnion Port (List UdpAncillary) Binary
• Udp_passive (UdpSocket ActiveSocket)

Instances

• Eq UdpMessage
• Generic UdpMessage _
• Show UdpMessage
• RuntimeType UdpMessage (RTOption (RTTuple5 (RTLiteralAtom "udp") RTWildcard RTWildcard RTInt RTBinary) (RTOption (RTTuple6 (RTLiteralAtomConvert "udp" "udpAnc") RTWildcard RTWildcard RTInt RTWildcard RTBinary) (RTTuple2 (RTLiteralAtom "udp_passive") RTWildcard)))

data UdpRecvData

Constructors

• Data IpAddressUnion Port Binary
• DataAnc IpAddressUnion Port (List UdpAncillary) Binary

Instances

• Eq UdpRecvData
• Show UdpRecvData

data UdpAncillary

Constructors

• Tos Int
• Tclass Int
• Ttl Int

Instances

• Eq UdpAncillary
• Generic UdpAncillary _
• Show UdpAncillary

data OpenError

Constructors

• OpenSystemLimit
• OpenPosix PosixError

Instances

• Eq OpenError
• Generic OpenError _
• Show OpenError

data OptionToMaybe

Instances

• ConvertOption OptionToMaybe "mode" a a
• ConvertOption OptionToMaybe sym (Maybe a) (Maybe a)
• ConvertOption OptionToMaybe sym a (Maybe a)

data SendError

Constructors

• SendNotOwner
• SendPosix PosixError

Instances

• Eq SendError
• Generic SendError _
• Show SendError

data ReceiveError

Constructors

• ReceiveNotOwner
• ReceiveTimeout
• ReceivePosix PosixError

Instances

• Eq ReceiveError
• Generic ReceiveError _
• Show ReceiveError

open :: forall options m. MonadEffect m => CanReceiveMessage UdpMessage m => Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record OpenOptions) (Record (ForcedOptions options)) (Record (ForcedOptions OpenOptions)) => Port -> Record options -> m (Either OpenError (UdpSocket ActiveSocket))

openPassive :: forall options. Lacks "active" options => Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record OpenOptions) (Record (ForcedOptions options)) (Record (ForcedOptions OpenOptions)) => Port -> Record options -> Effect (Either OpenError (UdpSocket PassiveSocket))

send :: forall socketMessageBehaviour. UdpSocket socketMessageBehaviour -> HostAddress -> Port -> IOData -> Effect (Either SendError Unit)

recv :: forall socketMessageBehaviour. UdpSocket socketMessageBehaviour -> Timeout -> Effect (Either ReceiveError UdpRecvData)

close :: forall socketMessageBehaviour. UdpSocket socketMessageBehaviour -> Effect Unit

port :: forall socketMessageBehaviour. UdpSocket socketMessageBehaviour -> Effect (Maybe Port)

setopts :: forall options socketMessageBehaviour. Union (ForcedOptions ()) options (ForcedOptions options) => Nub (ForcedOptions options) (ForcedOptions options) => ConvertOptionsWithDefaults OptionToMaybe (Record (Options ())) (Record (ForcedOptions options)) (Record (ForcedOptions (Options ()))) => OptionsValid socketMessageBehaviour options => UdpSocket socketMessageBehaviour -> Record options -> Effect (Either PosixError Unit)

convertPassiveToActive :: forall m. MonadEffect m => CanReceiveMessage UdpMessage m => UdpSocket PassiveSocket -> UdpSocket ActiveSocket