Giter VIP home page Giter VIP logo

erlang-mqtt's Introduction

erlang-mqtt Build Status

MQTT Protocol library for Erlang/Elixir. This library provides the low level building blocks for MQTT.

Protocol

mqtt_packet exposes an encode function and a decode function to convert binaries to MQTT packets as defined in mqtt/include/mqtt_packet.hrl

Client

mqtt_client provides a simple client for MQTT. Currently this client only supports QoS 0 messages.

Example Erlang client usage

ok = application:ensure_all_started(mqtt),

{ok, Connection, false} = mqtt_client:connect(#{
    transport => {tcp, #{host => "localhost"}}
}),

Topic = <<"/test">>,
{ok, [{Topic, 0}]} = mqtt_client:subscribe(Connection, [{topic, 0}]),

ok = mqtt_client:publish(Connection, Topic, <<"Hello">>),
receive
    {mqtt_client, Connection, {publish, Topic, Message, _}} ->
        io:format("Got ~s published on ~s~n", [Message, Topic]
end.

Example Elixir client usage

{:ok, connection, false} = MQTT.Client.connect(%{
    transport: {:tcp, %{host: "localhost"}}
})

topic = "/test"
{:ok, [{^topic, 0}]} = MQTT.Client.subscribe(connection, [{topic, 0}])

:ok = MQTT.Client.publish(connection, topic, "Hello")
receive do
    {:mqtt_client, ^connection, {:publish, ^topic, message, _}} ->
        IO.puts "Got #{message} published on #{topic}"
end

Server

mqtt_server provides a server behaviour for MQTT. A server would implement the mqtt_server behaviour, and would then be able to accept MQTT connections from clients. Currently this server only supports QoS 0 messages.

TODO

Add support for QoS 1 and 2

We need to add support for QoS 1 and 2 messages, this would require implementing a storage module in order to persist messages until they get acknowledged by the broker.

erlang-mqtt's People

Contributors

asabil avatar ericr3r avatar harshadkopera avatar michaelklishin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

erlang-mqtt's Issues

Documentation needed for MQTT.Server

I'm having trouble running the server. I'm running mix test with the following test in it:

defmodule MyMqttServerTest do
  use ExUnit.Case
  alias MQTT.Client

  test "greets the world" do
    {:ok, connection, false} = MQTT.Client.connect(%{
        transport: {:tcp, %{host: "localhost", port: 1883}},
        client_id: UUID.uuid1()
    })

    topic = "/hello"
    message = "hello"

    {:ok, [{^topic, 0}]} = Client.subscribe(connection, [{topic, 0}])
    :ok = Client.publish(connection, topic, message)

    assert_receive {:mqtt_client, ^connection, {:publish, ^topic, ^message, _}}

    :ok = Client.disconnect(connection)
  end
end

Child process:

%{
  id: MyMqttServer,
  type: :worker,
  start: {MyMqttServer, :start_link, [[:hello]]}
}
defmodule MyMqttServer do
  use MQTT.Server

  def start_link(state) do
    GenServer.start_link(__MODULE__, state, name: __MODULE__)
  end

  def init(stack) do
    {:ok, stack}
  end

  def init(stack, _) do
    {:ok, stack}
  end
  
  def handle_subscribe(_topic, _qos, state) do
    IO.inspect("I never get output")
    {:ok, state}
  end
end

It seems to be running but I can't seem to override the fun? I'm still relatively new to this so apologies if this is a simple question.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.