MOQX.Event.SubgroupEnded (moqx v0.10.0)

Copy Markdown View Source

One subscribed subgroup stream ended after all preceding object events.

A :complete outcome means the peer sent FIN and every object in that subgroup from the subscription start was received. Other outcomes do not imply that the subgroup is complete.

object_count is the number of complete objects received on this stream when the protocol supplies it (currently Lite); otherwise it is nil. Only outcome: :complete with object_count: 0 identifies a genuinely empty group. Zero objects before RESET or connection loss never implies an empty group. An object with a zero-byte payload still counts as one object.

Summary

Types

outcome()
t()

Types

outcome()

@type outcome() :: :complete | :reset | :closed

t()

@type t() :: %MOQX.Event.SubgroupEnded{
  end_of_group?: boolean(),
  error_code: non_neg_integer() | nil,
  group_id: non_neg_integer(),
  object_count: non_neg_integer() | nil,
  outcome: outcome(),
  subgroup_id: non_neg_integer() | nil,
  subscription: MOQX.Subscription.t()
}