NetworkStats
Defined in: packages/core/src/network-stats.ts:9
Counter container for network statistics.
Enable via enableNetworkStats: true in PeerborneConfig, then access
via peerborne.networkStats. Callers must invoke record*() methods
explicitly to update counters — automatic event wiring is not yet
implemented and will be added in a follow-up.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NetworkStats():
NetworkStats
Returns
Section titled “Returns”NetworkStats
Methods
Section titled “Methods”recordDocumentClose()
Section titled “recordDocumentClose()”recordDocumentClose():
void
Defined in: packages/core/src/network-stats.ts:42
Record a document close.
Returns
Section titled “Returns”void
recordDocumentOpen()
Section titled “recordDocumentOpen()”recordDocumentOpen():
void
Defined in: packages/core/src/network-stats.ts:37
Record a document open.
Returns
Section titled “Returns”void
recordPeerConnect()
Section titled “recordPeerConnect()”recordPeerConnect():
void
Defined in: packages/core/src/network-stats.ts:47
Record a peer connection.
Returns
Section titled “Returns”void
recordPeerDisconnect()
Section titled “recordPeerDisconnect()”recordPeerDisconnect():
void
Defined in: packages/core/src/network-stats.ts:52
Record a peer disconnection.
Returns
Section titled “Returns”void
recordReceived()
Section titled “recordReceived()”recordReceived(
bytes):void
Defined in: packages/core/src/network-stats.ts:31
Record an incoming message.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
recordSent()
Section titled “recordSent()”recordSent(
bytes):void
Defined in: packages/core/src/network-stats.ts:25
Record an outgoing message.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
reset()
Section titled “reset()”reset():
void
Defined in: packages/core/src/network-stats.ts:71
Reset all counters to zero.
Returns
Section titled “Returns”void
snapshot()
Section titled “snapshot()”snapshot():
NetworkStatsSnapshot
Defined in: packages/core/src/network-stats.ts:57
Get a snapshot of current statistics.