Modbux v0.3.10

Modbux.Tcp (Modbux v0.3.10) View Source

Tcp message helper, functions that handles TCP responses/requests messages.

Link to this section Summary

Functions

pack_req(cmd, transid)
pack_res(cmd, values, transid)
parse_req(wraped)
parse_res(cmd, wraped, transid)
req_len(cmd)
res_len(cmd)
unwrap(inv_data)
unwrap(msg, transid)
wrap(payload, transid)

Link to this section Functions

Link to this function

pack_req(cmd, transid)

View Source

Specs

pack_req(
  {:fc | :phr | :rc | :rhr | :ri | :rir, integer(), integer(),
   maybe_improper_list() | integer()},
  integer()
) :: <<_::48, _::_*8>>
Link to this function

pack_res(cmd, values, transid)

View Source

Specs

pack_res(
  {:fc | :phr | :rc | :rhr | :ri | :rir, integer(), any(),
   maybe_improper_list() | integer()},
  any(),
  integer()
) :: <<_::48, _::_*8>>
Link to this function

parse_req(wraped)

View Source

Specs

parse_req(<<_::48, _::_*8>>) ::
  {{:einval | :error | :fc | :phr | :rc | :rhr | :ri | :rir, byte(), char(),
    [any()] | char()}, char()}
Link to this function

parse_res(cmd, wraped, transid)

View Source

Specs

parse_res(any(), <<_::48, _::_*8>>, char()) ::
  nil | [any()] | {:error, any()} | {:error, byte(), <<_::104>>}
Link to this function

req_len(cmd)

View Source

Specs

req_len({:fc | :phr | :rc | :rhr | :ri | :rir, any(), any(), any()}) ::
  integer()
Link to this function

res_len(cmd)

View Source

Specs

res_len({:fc | :phr | :rc | :rhr | :ri | :rir, any(), any(), any()}) :: number()
Link to this function

unwrap(inv_data)

View Source

Specs

unwrap(<<_::48, _::_*8>>) :: {binary(), char()}
Link to this function

unwrap(msg, transid)

View Source

Specs

unwrap(<<_::48, _::_*8>>, char()) :: nil | binary()
Link to this function

wrap(payload, transid)

View Source

Specs

wrap(binary(), integer()) :: <<_::48, _::_*8>>