Module
Erl.Kernel.Udp
- Package
- erl-kernel
- Repository
- id3as/purescript-erl-kernel
#Options Source
type Options :: Row Type -> Row Type
type 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)
#OpenOptions Source
type OpenOptions :: Row Type
type 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)
#UdpSocket Source
data UdpSocket :: SocketMessageBehaviour -> Type
Instances
#UdpMessage Source
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)))
#UdpRecvData Source
#UdpAncillary Source
#OptionToMaybe Source
data OptionToMaybe
Instances
ConvertOption OptionToMaybe "mode" a a
ConvertOption OptionToMaybe sym (Maybe a) (Maybe a)
ConvertOption OptionToMaybe sym a (Maybe a)
#ReceiveError Source
#open Source
open :: forall options m msg. MonadEffect m => ReceivesMessage m msg => IsSupportedMessage UdpMessage msg => 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 Source
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))
#recv Source
recv :: forall socketMessageBehaviour. UdpSocket socketMessageBehaviour -> Timeout -> Effect (Either ReceiveError UdpRecvData)
#setopts Source
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 Source
convertPassiveToActive :: forall msg m. MonadEffect m => ReceivesMessage m msg => IsSupportedMessage UdpMessage msg => UdpSocket PassiveSocket -> UdpSocket ActiveSocket