View Source AprsUtils.AprsIsClient behaviour (AprsUtils v0.1.0)

Callbacks for the AprsUtils.AprsIs client module

Summary

Callbacks

Called when the connection to the APRS-IS server is disconnected. reason is a term describing the reason for the disconnection. The return value is ignored.

Called when a comment is recieved from the APRS-IS server. Note that comment is a binary, but not necessarily a valid String. The return value is ignored.

Called when a packet is recieved from the APRS-IS server. Note that packet is a binary, but not necessarily a valid String. packet_count is the number of packets recieved since the connection was established. The return value is ignored.

Callbacks

@callback disconnected(reason :: term()) :: :ok

Called when the connection to the APRS-IS server is disconnected. reason is a term describing the reason for the disconnection. The return value is ignored.

@callback got_comment(comment :: binary()) :: :ok

Called when a comment is recieved from the APRS-IS server. Note that comment is a binary, but not necessarily a valid String. The return value is ignored.

Link to this callback

got_packet(packet, packet_count)

View Source
@callback got_packet(packet :: binary(), packet_count :: integer()) :: :ok

Called when a packet is recieved from the APRS-IS server. Note that packet is a binary, but not necessarily a valid String. packet_count is the number of packets recieved since the connection was established. The return value is ignored.