io.opencensus.trace

Class NetworkEvent

java.lang.Object

io.opencensus.trace.BaseMessageEvent

io.opencensus.trace.NetworkEvent

Deprecated.

Use MessageEvent.

@Immutable
 @Deprecated
public abstract class NetworkEvent
extends BaseMessageEvent

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.

Since:

0.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkEvent.Builder Deprecated. NetworkEvent is deprecated. Please use MessageEvent and its builder MessageEvent.Builder.
static class	NetworkEvent.Type Deprecated. Available types for a NetworkEvent.

Method Summary

Modifier and Type	Method and Description
static NetworkEvent.Builder	builder(NetworkEvent.Type type, long messageId) Deprecated. Returns a new NetworkEvent.Builder with default values.
abstract long	getCompressedMessageSize() Deprecated. Returns the compressed size in bytes of the NetworkEvent.
abstract Timestamp	getKernelTimestamp() Deprecated. Returns the kernel timestamp associated with the NetworkEvent or null if not set.
abstract long	getMessageId() Deprecated. Returns the message id argument that serves to uniquely identify each network message.
long	getMessageSize() Deprecated. Use getUncompressedMessageSize().
abstract NetworkEvent.Type	getType() Deprecated. Returns the type of the NetworkEvent.
abstract long	getUncompressedMessageSize() Deprecated. Returns the uncompressed size in bytes 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)

Deprecated.

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.

Since:

0.5

getKernelTimestamp

@Nullable
public abstract Timestamp getKernelTimestamp()

Deprecated.

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.

Since:

0.5

getType

public abstract NetworkEvent.Type getType()

Deprecated.

Returns the type of the NetworkEvent.

Returns:

the type of the NetworkEvent.

Since:

0.5

getMessageId

public abstract long getMessageId()

Deprecated.

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

Returns:

the message id of the NetworkEvent.

Since:

0.5

getUncompressedMessageSize

public abstract long getUncompressedMessageSize()

Deprecated.

Returns the uncompressed size in bytes of the NetworkEvent.

Returns:

the uncompressed size in bytes of the NetworkEvent.

Since:

0.6

getCompressedMessageSize

public abstract long getCompressedMessageSize()

Deprecated.

Returns the compressed size in bytes of the NetworkEvent.

Returns:

the compressed size in bytes of the NetworkEvent.

Since:

0.6

getMessageSize

@Deprecated
public long getMessageSize()

Deprecated. Use getUncompressedMessageSize().

Returns the uncompressed size in bytes of the NetworkEvent.

Returns:

the uncompressed size in bytes of the NetworkEvent.

Since:

0.5