io.rsocket.Payload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rsocket-core Show documentation
Core functionality for the RSocket library
The newest version!
/*
 * Copyright 2015-2018 the original author or 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.rsocket;

import io.netty.buffer.ByteBuf;
import io.netty.util.ReferenceCounted;
import io.netty.util.ResourceLeakDetector;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;

/** Payload of a Frame . */
public interface Payload extends ReferenceCounted {
  /**
   * Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
   *
   * @return whether payload has non-null (possibly empty) metadata
   */
  boolean hasMetadata();

  /**
   * Returns a slice Payload metadata. Always non-null, check {@link #hasMetadata()} to
   * differentiate null from "".
   *
   * @return payload metadata.
   */
  ByteBuf sliceMetadata();

  /**
   * Returns the Payload data. Always non-null.
   *
   * @return payload data.
   */
  ByteBuf sliceData();

  /**
   * Returns the Payloads' data without slicing if possible. This is not safe and editing this could
   * effect the payload. It is recommended to call sliceData().
   *
   * @return data as a bytebuf or slice of the data
   */
  ByteBuf data();

  /**
   * Returns the Payloads' metadata without slicing if possible. This is not safe and editing this
   * could effect the payload. It is recommended to call sliceMetadata().
   *
   * @return metadata as a bytebuf or slice of the metadata
   */
  ByteBuf metadata();

  /** Increases the reference count by {@code 1}. */
  @Override
  Payload retain();

  /** Increases the reference count by the specified {@code increment}. */
  @Override
  Payload retain(int increment);

  /**
   * Records the current access location of this object for debugging purposes. If this object is
   * determined to be leaked, the information recorded by this operation will be provided to you via
   * {@link ResourceLeakDetector}. This method is a shortcut to {@link #touch(Object) touch(null)}.
   */
  @Override
  Payload touch();

  /**
   * Records the current access location of this object with an additional arbitrary information for
   * debugging purposes. If this object is determined to be leaked, the information recorded by this
   * operation will be provided to you via {@link ResourceLeakDetector}.
   */
  @Override
  Payload touch(Object hint);

  default ByteBuffer getMetadata() {
    return sliceMetadata().nioBuffer();
  }

  default ByteBuffer getData() {
    return sliceData().nioBuffer();
  }

  default String getMetadataUtf8() {
    return sliceMetadata().toString(StandardCharsets.UTF_8);
  }

  default String getDataUtf8() {
    return sliceData().toString(StandardCharsets.UTF_8);
  }
}