net.openhft.chronicle.network

Interface NetworkStats<T extends NetworkStats>

All Superinterfaces:

net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

All Known Implementing Classes:

WireNetworkStats

public interface NetworkStats<T extends NetworkStats>
extends net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.wire.WriteMarshallable

used to collected stats about the network activity

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Method Summary

Modifier and Type	Method and Description
UUID	clientId()
void	clientId(UUID clientId)
boolean	isAcceptor()
void	isAcceptor(boolean isAcceptor)
boolean	isConnected()
void	isConnected(boolean isConnected)
int	localIdentifier()
T	localIdentifier(int localIdentifier)
void	percentile50th(long value)
void	percentile90th(long value)
void	percentile99_9th(long value)
void	percentile99th(long value)
long	readBps()
T	readBps(long readBps)
String	remoteHostName()
T	remoteHostName(String hostName)
int	remoteIdentifier() the identifier of the remote instance of engine
T	remoteIdentifier(int remoteIdentifier)
int	remotePort()
void	remotePort(int port)
long	socketPollCountPerSecond()
T	socketPollCountPerSecond(long socketPollCountPerSecond)
long	timestamp()
T	timestamp(long timestamp)
String	userId()
T	userId(String userId)
long	writeBps()
T	writeBps(long writeBps)

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

readMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

writeMarshallable, writeValue

Method Detail

userId

@NotNull
T userId(String userId)

writeBps

long writeBps()

Returns:

bytes per second

writeBps

@NotNull
T writeBps(long writeBps)

readBps

long readBps()

Returns:

bytes per second

readBps

@NotNull
T readBps(long readBps)

socketPollCountPerSecond

long socketPollCountPerSecond()

Returns:

how many times was a socket read attempted within a second, a low number here is an indication that your system may be struggling to keep up

socketPollCountPerSecond

@NotNull
T socketPollCountPerSecond(long socketPollCountPerSecond)

timestamp

long timestamp()

timestamp

@NotNull
T timestamp(long timestamp)

remotePort

void remotePort(int port)

remoteHostName

@NotNull
T remoteHostName(String hostName)

userId

String userId()

localIdentifier

int localIdentifier()

Returns:

the identifier of this instance of engine

localIdentifier

@NotNull
T localIdentifier(int localIdentifier)

isAcceptor

boolean isAcceptor()

isAcceptor

void isAcceptor(boolean isAcceptor)

remoteIdentifier

int remoteIdentifier()

the identifier of the remote instance of engine

remoteIdentifier

@NotNull
T remoteIdentifier(int remoteIdentifier)

clientId

void clientId(UUID clientId)

clientId

UUID clientId()

remoteHostName

String remoteHostName()

remotePort

int remotePort()

isConnected

boolean isConnected()

isConnected

void isConnected(boolean isConnected)

percentile50th

void percentile50th(long value)

Parameters:

value - round trip latency, 50th percentile

percentile90th

void percentile90th(long value)

Parameters:

value - round trip latency, 90th percentile

percentile99th

void percentile99th(long value)

Parameters:

value - round trip latency, 99th percentile

percentile99_9th

void percentile99_9th(long value)

Parameters:

value - round trip latency, 99.9th percentile