io.opencensus.trace.MessageEvent Maven / Gradle / Ivy
/*
* Copyright 2018, OpenCensus Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.opencensus.trace;
import com.google.auto.value.AutoValue;
import io.opencensus.internal.Utils;
import javax.annotation.concurrent.Immutable;
/**
* A class that represents a generic messaging event. This class can represent messaging happened in
* any layer, especially higher application layer. Thus, it can be used when recording events in
* pipeline works, in-process bidirectional streams and batch processing.
*
* It requires a {@link Type type} and a message id that serves to uniquely identify each
* message. It can optionally have information about the message size.
*
* @since 0.12
*/
@Immutable
@AutoValue
@SuppressWarnings("deprecation")
public abstract class MessageEvent extends BaseMessageEvent {
/**
* Available types for a {@code MessageEvent}.
*
* @since 0.12
*/
public enum Type {
/**
* When the message was sent.
*
* @since 0.12
*/
SENT,
/**
* When the message was received.
*
* @since 0.12
*/
RECEIVED,
}
/**
* Returns a new {@link Builder} with default values.
*
* @param type designates whether this is a send or receive message.
* @param messageId serves to uniquely identify each message.
* @return a new {@code Builder} with default values.
* @throws NullPointerException if {@code type} is {@code null}.
* @since 0.12
*/
public static Builder builder(Type type, long messageId) {
return new AutoValue_MessageEvent.Builder()
.setType(Utils.checkNotNull(type, "type"))
.setMessageId(messageId)
// We need to set a value for the message size because the autovalue requires all
// primitives to be initialized.
.setUncompressedMessageSize(0)
.setCompressedMessageSize(0);
}
/**
* Returns the type of the {@code MessageEvent}.
*
* @return the type of the {@code MessageEvent}.
* @since 0.12
*/
public abstract Type getType();
/**
* Returns the message id argument that serves to uniquely identify each message.
*
* @return the message id of the {@code MessageEvent}.
* @since 0.12
*/
public abstract long getMessageId();
/**
* Returns the uncompressed size in bytes of the {@code MessageEvent}.
*
* @return the uncompressed size in bytes of the {@code MessageEvent}.
* @since 0.12
*/
public abstract long getUncompressedMessageSize();
/**
* Returns the compressed size in bytes of the {@code MessageEvent}.
*
* @return the compressed size in bytes of the {@code MessageEvent}.
* @since 0.12
*/
public abstract long getCompressedMessageSize();
/**
* Builder class for {@link MessageEvent}.
*
* @since 0.12
*/
@AutoValue.Builder
public abstract static class Builder {
// Package protected methods because these values are mandatory and set only in the
// MessageEvent#builder() function.
abstract Builder setType(Type type);
abstract Builder setMessageId(long messageId);
/**
* Sets the uncompressed message size.
*
* @param uncompressedMessageSize represents the uncompressed size in bytes of this message.
* @return this.
* @since 0.12
*/
public abstract Builder setUncompressedMessageSize(long uncompressedMessageSize);
/**
* Sets the compressed message size.
*
* @param compressedMessageSize represents the compressed size in bytes of this message.
* @return this.
* @since 0.12
*/
public abstract Builder setCompressedMessageSize(long compressedMessageSize);
/**
* Builds and returns a {@code MessageEvent} with the desired values.
*
* @return a {@code MessageEvent} with the desired values.
* @since 0.12
*/
public abstract MessageEvent build();
Builder() {}
}
MessageEvent() {}
}