Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions cpp/moq/include/moq/moq.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

#include <moq/ffi/moq.hpp>

#include <chrono>
#include <functional>
#include <string>
#include <utility>
Expand Down Expand Up @@ -192,6 +193,24 @@ inline expected<void> log_level(const std::string &level) {
return moq_log_level(level);
}

// Mints a fresh publisher epoch, ordered newest last. Announce one per run in Route::epoch,
// so viewers see a restart as a new broadcast instead of a stalled one.
inline std::string mint_epoch() {
return moq_mint_epoch();
}

// The wall-clock time an epoch encodes, to the millisecond. Errors unless it is a UUIDv7.
// Millisecond ticks hold every 48-bit UUIDv7 time, where system_clock's nanoseconds overflow in 2262.
inline expected<std::chrono::time_point<std::chrono::system_clock, std::chrono::milliseconds>>
epoch_time(const std::string &epoch) {
auto ms = moq_epoch_time_ms(epoch);
if (!ms) {
return unexpected(std::move(ms).error());
}
return std::chrono::time_point<std::chrono::system_clock, std::chrono::milliseconds>(
std::chrono::milliseconds(static_cast<std::chrono::milliseconds::rep>(*ms)));
}

#ifdef MOQ_COROUTINES
namespace detail {

Expand Down
7 changes: 7 additions & 0 deletions cpp/moq/test/probe.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,13 @@ int main() {
// It prints the message Rust's Display gives.
CHECK(fingerprints.error().to_string() == "bind: not listening; call listen() first");

// An epoch's time keeps every 48-bit millisecond, past where system_clock's nanoseconds wrap.
CHECK(ok(moq::epoch_time("018bcfe5-6800-7000-8000-000000000000"), "epoch_time").time_since_epoch() ==
std::chrono::milliseconds(1700000000000));
CHECK(ok(moq::epoch_time("ffffffff-ffff-7000-8000-000000000000"), "epoch_time").time_since_epoch() ==
std::chrono::milliseconds(0xffffffffffff));
CHECK(!moq::epoch_time("not-an-epoch"));

// Publisher: a server whose origin serves one broadcast with one track.
auto origin = moq::OriginProducer::init({});
auto broadcast = ok(origin->create_broadcast("probe"), "create_broadcast");
Expand Down
12 changes: 6 additions & 6 deletions cpp/obs/src/moq-output.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ void MoQOutput::OnConnect(const std::shared_ptr<Attempt> &current, moq::expected

auto elapsed = std::chrono::steady_clock::now() - current->started;
auto ms = static_cast<int>(std::chrono::duration_cast<std::chrono::milliseconds>(elapsed).count());
const int connect_epoch = static_cast<int>((*result)->epoch());
const int connects = static_cast<int>((*result)->connects());

current->session = *result;
current->connected = true;
Expand All @@ -256,7 +256,7 @@ void MoQOutput::OnConnect(const std::shared_ptr<Attempt> &current, moq::expected
// Clamp sub-millisecond connects to 1 so that sentinel stays honest.
connect_time_ms = ms > 0 ? ms : 1;

LOG_INFO("MoQ session connected (%d ms, epoch %d): %s", ms, connect_epoch, MoQRedactUrl(current->url).c_str());
LOG_INFO("MoQ session connected (%d ms, connect %d): %s", ms, connects, MoQRedactUrl(current->url).c_str());

WatchStatus(current);
}
Expand All @@ -282,15 +282,15 @@ void MoQOutput::OnStatus(const std::shared_ptr<Attempt> &current, moq::expected<

switch (*result) {
case moq::ConnectionStatus::kConnected: {
const int connect_epoch = static_cast<int>(current->session->epoch());
const int connects = static_cast<int>(current->session->connects());
current->live = true;
{
std::lock_guard<std::mutex> lock(mutex);
live = true;
last_failure_code = MoQError::None;
last_failure_reason.clear();
}
LOG_INFO("MoQ session reconnected (epoch %d): %s", connect_epoch, MoQRedactUrl(current->url).c_str());
LOG_INFO("MoQ session reconnected (connect %d): %s", connects, MoQRedactUrl(current->url).c_str());
break;
}
case moq::ConnectionStatus::kDisconnected: {
Expand Down Expand Up @@ -472,8 +472,8 @@ int MoQOutput::GetReconnectCount()
}
// Read live rather than tracked from status(), which coalesces a drop that
// reconnects before it is asked again.
const uint64_t connect_epoch = current ? current->epoch() : 0;
return connect_epoch > 1 ? static_cast<int>(connect_epoch - 1) : 0;
const uint64_t connects = current ? current->connects() : 0;
return connects > 1 ? static_cast<int>(connects - 1) : 0;
}

bool MoQOutput::IsLiveSession()
Expand Down
2 changes: 1 addition & 1 deletion cpp/obs/src/moq-output.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class MoQOutput {
};
bool TryGetConnectionStats(ConnectionStats *out);

// Successful (re)connects after the first for this Start(); 0 until epoch >= 2.
// Successful (re)connects after the first for this Start(); 0 until connects() >= 2.
int GetReconnectCount();

// True while the current Start() attempt has an open MoQ session.
Expand Down
4 changes: 2 additions & 2 deletions cpp/obs/src/moq-source.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ static void moq_source_on_connect(struct moq_source *ctx, const std::shared_ptr<
}

conn->session = *result;
LOG_INFO("MoQ session connected (epoch %llu)", (unsigned long long)conn->session->epoch());
LOG_INFO("MoQ session connected (connect %llu)", (unsigned long long)conn->session->connects());
moq_source_watch_status(ctx, conn);

// Wait for the broadcast to be announced. Announcements arrive over the session
Expand Down Expand Up @@ -521,7 +521,7 @@ static void moq_source_on_status(struct moq_source *ctx, const std::shared_ptr<C
switch (*result) {
case moq::ConnectionStatus::kConnected:
// The existing subscriptions ride out the gap; nothing to redo.
LOG_INFO("MoQ session reconnected (epoch %llu)", (unsigned long long)conn->session->epoch());
LOG_INFO("MoQ session reconnected (connect %llu)", (unsigned long long)conn->session->connects());
break;
case moq::ConnectionStatus::kDisconnected:
LOG_WARNING("MoQ session dropped, reconnecting");
Expand Down
14 changes: 9 additions & 5 deletions dart/moq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ final announced = connection.announced(
options: const AnnounceOptions(prefix: 'live/', filter: '*/camera'),
);
await for (final event in announced.updates()) {
if (event is AnnounceEventStart) {
// Prefix stays origin-relative; captures reports wildcard matches.
print(event.announce.prefix);
print(event.announce.captures);
// A restart is a new publisher run at the same path: request it again.
switch (event) {
case AnnounceEventStart(:final announce) ||
AnnounceEventRestart(:final announce):
// Prefix stays origin-relative; captures reports wildcard matches.
print(announce.prefix);
print(announce.captures);
default:
}
}
```
Expand All @@ -32,7 +36,7 @@ final broadcast = server.createBroadcast('live');
broadcast.announce(route: MoqRoute()); // unannounced broadcasts are invisible
await for (final request in server.requests()) {
final session = await request.accept();
print(session.epoch());
print(session.connects());
}
```

Expand Down
1 change: 1 addition & 0 deletions dart/moq/lib/moq.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ export 'package:moq_ffi/moq_ffi.dart';
export 'src/aliases.dart';
export 'src/client.dart';
export 'src/durations.dart';
export 'src/epoch.dart';
export 'src/server.dart';
6 changes: 5 additions & 1 deletion dart/moq/lib/src/aliases.dart
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ typedef AnnouncedBroadcast = MoqAnnouncedBroadcast;
typedef Announce = MoqAnnounce;

/// What an [AnnounceConsumer] yields: [AnnounceEventStart],
/// [AnnounceEventUpdate], or [AnnounceEventEnd].
/// [AnnounceEventUpdate], [AnnounceEventEnd], or [AnnounceEventRestart].
typedef AnnounceEvent = MoqAnnounceEvent;

/// A route now covers the prefix; the stream had none there.
Expand All @@ -65,6 +65,10 @@ typedef AnnounceEventUpdate = UpdateMoqAnnounceEvent;
/// No route covers the prefix any more; carries its last route.
typedef AnnounceEventEnd = EndMoqAnnounceEvent;

/// Another publisher instance now serves the prefix: drop what was resolved
/// under it and request afresh.
typedef AnnounceEventRestart = RestartMoqAnnounceEvent;

/// The write side of a broadcast: publish tracks into it.
typedef BroadcastProducer = MoqBroadcastProducer;

Expand Down
4 changes: 2 additions & 2 deletions dart/moq/lib/src/client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,9 @@ final class Moq {
Future<BroadcastConsumer> requestBroadcast(String path) =>
session.consume().requestBroadcast(path: path);

/// The connection epoch: 1 for the connect that built this session, one more
/// How many times this session has connected: 1 for the connect that built it, one more
/// on each reconnect. A server-accepted session stays at 1.
int get epoch => session.epoch();
int get connects => session.connects();

/// The session's bandwidth allocator.
///
Expand Down
14 changes: 14 additions & 0 deletions dart/moq/lib/src/epoch.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import 'package:moq_ffi/moq_ffi.dart';

/// Mint a fresh publisher epoch from the wall clock and secure randomness,
/// ordered newest last. Mint one per publisher run and announce it in
/// `MoqRoute.epoch`, so viewers see a restart as a new broadcast instead of a
/// stalled one.
String mintEpoch() => moqMintEpoch();

/// The UTC wall-clock time [epoch] encodes, to the millisecond. Throws unless
/// it is a lowercase hyphenated UUIDv7.
DateTime epochTime(String epoch) => DateTime.fromMillisecondsSinceEpoch(
moqEpochTimeMs(epoch: epoch),
isUtc: true,
);
24 changes: 24 additions & 0 deletions dart/moq/test/moq_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,30 @@ void main() {
announced.dispose();
});

test('a new epoch restarts announce consumers', () async {
final origin = MoqOriginProducer(config: MoqOriginConfig());
final announced = origin.consume().announced(config: MoqAnnounceConfig());
final broadcast = origin.createBroadcast(path: 'epoch');

final first = mintEpoch();
expect(
epochTime('018bcfe5-6800-7000-8000-000000000000'),
DateTime.utc(2023, 11, 14, 22, 13, 20),
);
broadcast.announce(route: MoqRoute(epoch: first));
final start = await nextRoute(announced) as AnnounceEventStart;
expect(start.announce.route.epoch, first);

final second = mintEpoch();
broadcast.announce(route: MoqRoute(epoch: second));
final restart = await nextRoute(announced) as AnnounceEventRestart;
expect(restart.announce.route.epoch, second);

expect(() => epochTime('not-an-epoch'), throwsA(isA<MoqException>()));
announced.cancel();
announced.dispose();
});

test('announced pattern reports captures', () async {
final origin = MoqOriginProducer(config: MoqOriginConfig());
final announced = origin.consume().announced(
Expand Down
Loading
Loading