Xirsys.Sockets.DatagramServer (xturn_sockets v2.1.0)

View Source

Datagram listener that drains every whole packet from each inbound datagram.

Default transport is Transport.UDP. Multi-tier pipelines can keep per-peer session state; otherwise each datagram is framed independently.

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

port(pid)

Bound port of a running server (useful when :port was 0).

start_link(opts)

Opens a datagram listener.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

port(pid)

Bound port of a running server (useful when :port was 0).

Parameters

start_link(opts)

Opens a datagram listener.

Parameters

opts is a keyword list:

  • :ip / :port - bind address (required)
  • :transport - transport module (default Transport.UDP)
  • :pipeline - pipeline module, or omit and pass :accumulator + :handler
  • :listen_opts - extra options forwarded to listen/3
  • :assigns - map copied onto each datagram's Conn
  • :handler_state - initial handler state for stateless datagrams
  • :tick_interval_ms - optional drain tick (also enables per-peer sessions when the pipeline has more than :root)