View Source vdist_entry_encode (erldist_filter v1.1.0)

Link to this section Summary

Link to this section Types

-type options() :: #{fragment_size => pos_integer(), header_mode => fragment | normal | pass_through}.

Link to this section Functions

Link to this function

encode(Entry, ControlMessage, Options)

View Source
-spec encode(Entry, ControlMessage, Options) -> {ok, Fragments, Entry}
          when
              Entry :: vdist_entry:t(),
              ControlMessage :: vdist:dop_without_payload_t(),
              Options :: options(),
              Fragments :: [binary()].
Link to this function

encode(Entry, ControlMessage, Payload, Options)

View Source
-spec encode(Entry, ControlMessage, Payload, Options) -> {ok, Fragments, Entry}
          when
              Entry :: vdist_entry:t(),
              ControlMessage :: vdist:dop_with_payload_t(),
              Payload :: vterm:t(),
              Options :: options(),
              Fragments :: [binary()].
Link to this function

encode_with_fragment_header(Entry, ControlMessage, Options)

View Source
-spec encode_with_fragment_header(Entry, ControlMessage, Options) -> {ok, Fragments, Entry}
                               when
                                   Entry :: vdist_entry:t(),
                                   ControlMessage :: vdist:dop_without_payload_t(),
                                   Options :: options(),
                                   Fragments :: [binary()].
Link to this function

encode_with_fragment_header(Entry, ControlMessage, Payload, Options)

View Source
-spec encode_with_fragment_header(Entry, ControlMessage, Payload, Options) -> {ok, Fragments, Entry}
                               when
                                   Entry :: vdist_entry:t(),
                                   ControlMessage :: vdist:dop_with_payload_t(),
                                   Payload :: vterm:t(),
                                   Options :: options(),
                                   Fragments :: [binary()].
Link to this function

encode_with_normal_header(Entry, ControlMessage, Options)

View Source
-spec encode_with_normal_header(Entry, ControlMessage, Options) -> {ok, Fragments, Entry}
                             when
                                 Entry :: vdist_entry:t(),
                                 ControlMessage :: vdist:dop_without_payload_t(),
                                 Options :: options(),
                                 Fragments :: [binary()].
Link to this function

encode_with_normal_header(Entry, ControlMessage, Payload, Options)

View Source
-spec encode_with_normal_header(Entry, ControlMessage, Payload, Options) -> {ok, Fragments, Entry}
                             when
                                 Entry :: vdist_entry:t(),
                                 ControlMessage :: vdist:dop_with_payload_t(),
                                 Payload :: vterm:t(),
                                 Options :: options(),
                                 Fragments :: [binary()].
Link to this function

encode_with_pass_through_header(Entry, ControlMessage, Options)

View Source
-spec encode_with_pass_through_header(Entry, ControlMessage, Options) -> {ok, Fragments, Entry}
                                   when
                                       Entry :: vdist_entry:t(),
                                       ControlMessage :: vdist:dop_without_payload_t(),
                                       Options :: options(),
                                       Fragments :: [binary()].
Link to this function

encode_with_pass_through_header(Entry, ControlMessage, Payload, Options)

View Source
-spec encode_with_pass_through_header(Entry, ControlMessage, Payload, Options) -> {ok, Fragments, Entry}
                                   when
                                       Entry :: vdist_entry:t(),
                                       ControlMessage :: vdist:dop_with_payload_t(),
                                       Payload :: vterm:t(),
                                       Options :: options(),
                                       Fragments :: [binary()].