Packages

udp_client_ex

0.1.4
0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

A simple library for sending messages via UDP.

HexDocs

Current section

Files

Jump to
Readme
5 Versions
0 Dependencies
Dependants
Files
Activity
udp_client_ex lib udp_ex udp_client_behaviour.ex
Raw

lib/udp_ex/udp_client_behaviour.ex 

defmodule UdpClientBehaviour do

  @moduledoc """


  Primary interface definition for sending data using UDP


  """



  @typedoc "Represents a valid UDP port number."

  @type udp_port_number_t :: 0..65535



  @typedoc "Represents the combination of an IP Address and port number."

  @type destination_t :: %{ip_address: String.t(), port: udp_port_number_t}



  @typedoc "Represents the data that can be send via UDP."

  @type data_t :: binary | String.t()



  @doc """


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


  """

  @callback send(data_t, destination_t) :: :ok | {:error, reason: any()}

end