UDP Client Ex

v0.1.4

UDP Client Ex v0.1.4 UdpClientBehaviour behaviour View Source

Primary interface definition for sending data using UDP

Link to this section Summary

Types

data_t()

Represents the data that can be send via UDP

destination_t()

Represents the combination of an IP Address and port number

udp_port_number_t()

Represents a valid UDP port number

Callbacks

send(data_t, destination_t)

Defines the method that allows data to be sent via UDP

Link to this section Types

Link to this type data_t() View Source 
data_t() :: binary() | String.t()

Represents the data that can be send via UDP.

Link to this type destination_t() View Source 
destination_t() :: %{ip_address: String.t(), port: udp_port_number_t()}

Represents the combination of an IP Address and port number.

Link to this type udp_port_number_t() View Source 
udp_port_number_t() :: 0..65535

Represents a valid UDP port number.

Link to this section Callbacks

Link to this callback send(data_t, destination_t) View Source 
send(data_t(), destination_t()) :: :ok | {:error, [{:reason, any()}]}

Defines the method that allows data to be sent via UDP.