io.opencensus.trace

Class NetworkEvent

java.lang.Object

io.opencensus.trace.NetworkEvent

@Immutable
public abstract class NetworkEvent
extends Object

A class that represents a network event. It requires a type and a message id that serves to uniquely identify each network message. It can optionally can have information about the kernel time and message size.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkEvent.Builder Builder class for NetworkEvent.
static class	NetworkEvent.Type Available types for a NetworkEvent.

Method Summary

Modifier and Type	Method and Description
static NetworkEvent.Builder	builder(NetworkEvent.Type type, long messageId) Returns a new NetworkEvent.Builder with default values.
abstract Timestamp	getKernelTimestamp() Returns the kernel timestamp associated with the NetworkEvent or null if not set.
abstract long	getMessageId() Returns the message id argument that serves to uniquely identify each network message.
abstract long	getMessageSize() Returns The message size in bytes of the NetworkEvent.
abstract NetworkEvent.Type	getType() Returns the type of the NetworkEvent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static NetworkEvent.Builder builder(NetworkEvent.Type type,
                                           long messageId)

Returns a new NetworkEvent.Builder with default values.

Parameters:

type - designates whether this is a network send or receive message.

messageId - serves to uniquely identify each network message.

Returns:

a new Builder with default values.

Throws:

NullPointerException - if type is null.

getKernelTimestamp

@Nullable
public abstract Timestamp getKernelTimestamp()

Returns the kernel timestamp associated with the NetworkEvent or null if not set.

Returns:

the kernel timestamp associated with the NetworkEvent or null if not set.

getType

public abstract NetworkEvent.Type getType()

Returns the type of the NetworkEvent.

Returns:

the type of the NetworkEvent.

getMessageId

public abstract long getMessageId()

Returns the message id argument that serves to uniquely identify each network message.

Returns:

The message id of the NetworkEvent.

getMessageSize

public abstract long getMessageSize()

Returns The message size in bytes of the NetworkEvent.

Returns:

The message size in bytes of the NetworkEvent.