From 5965db72a081d85b50b2188b228fa94a0dfa549d Mon Sep 17 00:00:00 2001 From: Orgad Shaneh Date: Mon, 5 Aug 2024 11:47:01 +0300 Subject: [PATCH] Document the complete event in README --- README.md | 8 +++++++- examples/tcp_metrics | 4 ---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 77aefd6..ecd30dd 100644 --- a/README.md +++ b/README.md @@ -208,7 +208,13 @@ If you no longer need to receive packets, you can use `pcap_session.close()`. To read packets from a file instead of from a live interface, use `createOfflineSession` instead: ```javascript -pcap.createOfflineSession('/path/to/capture.pcap', options); +const pcap_session = pcap.createOfflineSession('/path/to/capture.pcap', options); +pcap_session.on('packet', function (raw_packet) { + // do some stuff with a raw packet +}); +pcap_session.on('complete', function () { + // do some stuff when file ends +}); ``` Where `options` only accepts the `filter` property. diff --git a/examples/tcp_metrics b/examples/tcp_metrics index 7f38d79..94ef3da 100755 --- a/examples/tcp_metrics +++ b/examples/tcp_metrics @@ -20,10 +20,6 @@ pcap_session.on("packet", function (raw_packet) { tcp_tracker.track_packet(packet); }); -pcap_session.on("complete", function () { - console.log("pcap session complete."); -}); - // tracker emits sessions, and sessions emit data tcp_tracker.on("session", function (session) { console.log("Start of TCP session between " + session.src_name + " and " + session.dst_name);