Payload (rsocket-core 1.1.1 API)

All Superinterfaces:

ReferenceCounted

All Known Implementing Classes:

ByteBufPayload, ConnectionSetupPayload, DefaultConnectionSetupPayload, DefaultPayload, EmptyPayload
```
public interface Payload
extends ReferenceCounted
```
Payload of a Frame .

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ByteBuf`	`data()` Returns the Payloads' data without slicing if possible.
`default ByteBuffer`	`getData()`
`default String`	`getDataUtf8()`
`default ByteBuffer`	`getMetadata()`
`default String`	`getMetadataUtf8()`
`boolean`	`hasMetadata()` Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
`ByteBuf`	`metadata()` Returns the Payloads' metadata without slicing if possible.
`Payload`	`retain()` Increases the reference count by `1`.
`Payload`	`retain(int increment)` Increases the reference count by the specified `increment`.
`ByteBuf`	`sliceData()` Returns the Payload data.
`ByteBuf`	`sliceMetadata()` Returns a slice Payload metadata.
`Payload`	`touch()` Records the current access location of this object for debugging purposes.
`Payload`	`touch(Object hint)` Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release

- Method Detail
  - hasMetadata
```
boolean hasMetadata()
```
    Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
    
    Returns:
    
    whether payload has non-null (possibly empty) metadata
  - sliceMetadata
```
ByteBuf sliceMetadata()
```
    Returns a slice Payload metadata. Always non-null, check hasMetadata() to differentiate null from "".
    
    Returns:
    
    payload metadata.
  - sliceData
```
ByteBuf sliceData()
```
    Returns the Payload data. Always non-null.
    
    Returns:
    
    payload data.
  - data
```
ByteBuf data()
```
    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().
    
    Returns:
    
    data as a bytebuf or slice of the data
  - metadata
```
ByteBuf metadata()
```
    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().
    
    Returns:
    
    metadata as a bytebuf or slice of the metadata
  - retain
```
Payload retain()
```
    Increases the reference count by 1.
    
    Specified by:
    
    retain in interface ReferenceCounted
  - retain
```
Payload retain(int increment)
```
    Increases the reference count by the specified increment.
    
    Specified by:
    
    retain in interface ReferenceCounted
  - touch
```
Payload touch()
```
    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 ResourceLeakDetector. This method is a shortcut to touch(null).
    
    Specified by:
    
    touch in interface ReferenceCounted
  - touch
```
Payload touch(Object hint)
```
    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 ResourceLeakDetector.
    
    Specified by:
    
    touch in interface ReferenceCounted
  - getMetadata
```
default ByteBuffer getMetadata()
```
  - getData
```
default ByteBuffer getData()
```
  - getMetadataUtf8
```
default String getMetadataUtf8()
```
  - getDataUtf8
```
default String getDataUtf8()
```

Interface Payload

Method Summary

Methods inherited from interface io.netty.util.ReferenceCounted

Method Detail

hasMetadata

sliceMetadata

sliceData

data

metadata

retain

retain

touch

touch

getMetadata

getData

getMetadataUtf8

getDataUtf8