Separate packet jitter from a fixed clock offset
Transit changes by 32 ticks. Starting from zero, the one-sixteenth update yields two ticks of smoothed jitter.
Run the native CLI
Extract the workflow collection for your platform. Run .\bin\cormorant.exe --help in PowerShell or ./bin/cormorant --help on Linux and macOS. Running the command with no arguments prints the worked example.
Build from source
With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.
git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-cormorant.git cd blyx-cormorant blyxc native-run project.blyx -- "0,16" "100,148" 0
Why this framework exists
Absolute one-way delay depends on clock alignment. Changes in transit can still reveal jitter when the clock offset is stable. IETF RFC 3550, interarrival jitter
Install Cormorant in your editor
Extension RahulChaube.blyx-cormorant · 0.1.0
The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.
Create an empty .blyx file, type blyx-cormorant-demo and accept the completion. Choose Blyx: Run File to run the example.
For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Cormorant.
Download the companion Blyx Language VSIXLibraries in this framework
Install with Conda
Create an environment containing Cormorant 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.
conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-cormorant=0.1.0=0 blyxc native-run ./blyx-env/share/blyx/cormorant/main.blyx
To use this package in your application, copy share/blyx/cormorant/vendor/cormorant from the environment into your project's vendor directory.
Import into a Blyx project
Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.
git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-cormorant.git vendor/cormorant
You can also download Cormorant as a ZIP. Extract its contents into vendor/cormorant.
Save this as main.blyx beside vendor and run blyxc native-run main.blyx.
use vendor::cormorant::cormorant;
fn main() {
let sent = [0, 16];
let arrived = [100, 148];
let initial = 0.0;
let result = cormorant_trace(sent, arrived, initial);
if len(result) == 0 { println!("invalid"); return; }
let mut i = 0;
while i < len(result) {
println!(at(result, i));
i += 1;
}
}Expected output
32 2 1
API and input requirements
Returns [transit range, smoothed jitter, adjacent pairs]. Input rows must be in arrival order and use unwrapped sender timestamps. Invalid arguments and nonfinite results return an empty vector.
| API | Use |
|---|---|
cormorant_trace(sent, arrived, initial) | Returns [transit range, smoothed jitter, adjacent pairs]. Input rows must be in arrival order and use unwrapped sender timestamps. |
Develop and contribute
Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.
