GSMLG.Socket.UDP (GSMLG.Socket v0.1.0)
This module wraps a UDP socket using gen_udp.
options
Options
When creating a socket you can pass a series of options to use for it.
:assets the kind of value returned by recv, either:binaryor:list, the default is:binary.:modecan be either:passiveor:active, default is:passive:localmust be a keyword list:addressthe local address to use:fdan already opened file descriptor to use
:versionsets the IP version to use:broadcastenables broadcast sending
examples
Examples
server = GSMLG.Socket.UDP.open!(1337)
{ data, client } = server |> GSMLG.Socket.Datagram.recv!
server |> GSMLG.Socket.Datagram.send! data, clientLink to this section Summary
Functions
Convert UDP options to :inet.setopts compatible arguments.
Create a UDP socket listening on an OS chosen port, use local to know the
port it was bound on.
Create a UDP socket listening on the given port or using the given options.
Create a UDP socket listening on the given port and using the given options.
Create a UDP socket listening on an OS chosen port, use local to know the
port it was bound on, raising if an error occurs.
Create a UDP socket listening on the given port or using the given options, raising if an error occurs.
Create a UDP socket listening on the given port and using the given options, raising if an error occurs.
Set options of the socket.
Set the process which will receive the messages.
Set the process which will receive the messages, raising if an error occurs.
Link to this section Types
@type t() :: port()
Link to this section Functions
arguments(options)
Convert UDP options to :inet.setopts compatible arguments.
open()
@spec open() :: {:ok, t()} | {:error, Error.t()}
Create a UDP socket listening on an OS chosen port, use local to know the
port it was bound on.
open(port)
@spec open(:inet.port_number() | Keyword.t()) :: {:ok, t()} | {:error, Error.t()}
Create a UDP socket listening on the given port or using the given options.
open(port, options)
@spec open(:inet.port_number(), Keyword.t()) :: {:ok, t()} | {:error, Error.t()}
Create a UDP socket listening on the given port and using the given options.
open!()
Create a UDP socket listening on an OS chosen port, use local to know the
port it was bound on, raising if an error occurs.
open!(port_or_options)
@spec open!(:inet.port_number() | Keyword.t()) :: t() | no_return()
Create a UDP socket listening on the given port or using the given options, raising if an error occurs.
open!(port, options)
@spec open!(:inet.port_number(), Keyword.t()) :: t() | no_return()
Create a UDP socket listening on the given port and using the given options, raising if an error occurs.
options(socket, opts)
Set options of the socket.
process(socket, pid)
Set the process which will receive the messages.
process!(socket, pid)
Set the process which will receive the messages, raising if an error occurs.