Socket.UDP (socket2 v2.1.2)

Copy Markdown

This module wraps a UDP socket using gen_udp.

Options

When creating a socket you can pass a series of options to use for it.

  • :as sets the kind of value returned by recv, either :binary or :list, the default is :binary.
  • :mode can be either :passive or :active, default is :passive
  • :local must be a keyword list
    • :address the local address to use
    • :fd an already opened file descriptor to use
  • :version sets the IP version to use
  • :broadcast enables broadcast sending

Examples

server = Socket.UDP.open!(1337)

{ data, client } = server |> Socket.Datagram.recv!
server |> Socket.Datagram.send! data, client

Summary

Types

t()

Functions

arguments(options)

Convert UDP options to :inet.setopts compatible arguments.

open()

Create a UDP socket listening on an OS chosen port, use local to know the port it was bound on.

open(port)

Create a UDP socket listening on the given port or using the given options.

open(port, options)

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)

Create a UDP socket listening on the given port or using the given options, raising if an error occurs.

open!(port, options)

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.

Types

t()

@type t() :: port()

Functions

arguments(options)

@spec arguments(Keyword.t()) :: list()

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

@spec open!() :: t() | no_return()

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)

@spec options(t(), Keyword.t()) :: :ok | {:error, Error.t()}

Set options of the socket.

process(socket, pid)

@spec process(t() | port(), pid()) :: :ok | {:error, :closed | :not_owner | Error.t()}

Set the process which will receive the messages.

process!(socket, pid)

@spec process!(t() | port(), pid()) :: :ok | no_return()

Set the process which will receive the messages, raising if an error occurs.