Top Description Fields Constructors Methods
io.rsocket.core

public Class DefaultConnectionSetupPayload

extends ConnectionSetupPayload
Class Inheritance
Imports
io.netty.buffer.ByteBuf, .Unpooled, io.rsocket.ConnectionSetupPayload, io.rsocket.frame.FrameHeaderCodec, .SetupFrameCodec
Default implementation of ConnectionSetupPayload. Primarily for internal use within RSocket Java but may be created in an application, e.g. for testing purposes.

Field Summary

Modifier and TypeField and Description
private final ByteBuf
setupFrame

Constructor Summary

AccessConstructor and Description
public
DefaultConnectionSetupPayload(ByteBuf setupFrame)

Method Summary

Modifier and TypeMethod and Description
public ByteBuf
data()

Implements io.rsocket.Payload.data.

Returns the Payloads' data without slicing if possible.
public String
dataMimeType()

Implements abstract io.rsocket.ConnectionSetupPayload.dataMimeType.

protected void
deallocate()

Implements abstract io.netty.util.AbstractReferenceCounted.deallocate.

Called once refCnt() is equals 0.
public int
getFlags()

Implements abstract io.rsocket.ConnectionSetupPayload.getFlags.

public boolean
hasMetadata()

Implements io.rsocket.Payload.hasMetadata.

Returns whether the payload has metadata, useful for tell if metadata is empty or not present.
public boolean
isResumeEnabled()

Implements abstract io.rsocket.ConnectionSetupPayload.isResumeEnabled.

public int
keepAliveInterval()

Implements abstract io.rsocket.ConnectionSetupPayload.keepAliveInterval.

public int
keepAliveMaxLifetime()

Implements abstract io.rsocket.ConnectionSetupPayload.keepAliveMaxLifetime.

public ByteBuf
metadata()

Implements io.rsocket.Payload.metadata.

Returns the Payloads' metadata without slicing if possible.
public String
metadataMimeType()

Implements abstract io.rsocket.ConnectionSetupPayload.metadataMimeType.

public ByteBuf
resumeToken()

Implements abstract io.rsocket.ConnectionSetupPayload.resumeToken.

public ByteBuf
sliceData()

Implements io.rsocket.Payload.sliceData.

Returns the Payload data.
public ByteBuf
sliceMetadata()

Implements io.rsocket.Payload.sliceMetadata.

Returns a slice Payload metadata.
public ConnectionSetupPayload
touch()

Implements abstract io.rsocket.ConnectionSetupPayload.touch.

Implements io.rsocket.Payload.touch, io.netty.util.ReferenceCounted.touch.

Records the current access location of this object for debugging purposes.
public ConnectionSetupPayload
touch(Object hint)

Implements io.rsocket.Payload.touch, io.netty.util.ReferenceCounted.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
public boolean
willClientHonorLease()

Implements abstract io.rsocket.ConnectionSetupPayload.willClientHonorLease.

Inherited from io.rsocket.ConnectionSetupPayload:
retainretain

Field Detail

setupFrameback to summary
private final ByteBuf setupFrame

Constructor Detail

DefaultConnectionSetupPayloadback to summary
public DefaultConnectionSetupPayload(ByteBuf setupFrame)

Method Detail

databack to summary
public ByteBuf data()

Implements io.rsocket.Payload.data.

Doc from io.rsocket.Payload.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:ByteBuf

data as a bytebuf or slice of the data

Annotations
@Override
dataMimeTypeback to summary
public String dataMimeType()

Implements abstract io.rsocket.ConnectionSetupPayload.dataMimeType.

Annotations
@Override
deallocateback to summary
protected void deallocate()

Implements abstract io.netty.util.AbstractReferenceCounted.deallocate.

Doc from io.netty.util.AbstractReferenceCounted.deallocate.

Called once refCnt() is equals 0.

Annotations
@Override
getFlagsback to summary
public int getFlags()

Implements abstract io.rsocket.ConnectionSetupPayload.getFlags.

Annotations
@Override
hasMetadataback to summary
public boolean hasMetadata()

Implements io.rsocket.Payload.hasMetadata.

Doc from io.rsocket.Payload.hasMetadata.

Returns whether the payload has metadata, useful for tell if metadata is empty or not present.

Returns:boolean

whether payload has non-null (possibly empty) metadata

Annotations
@Override
isResumeEnabledback to summary
public boolean isResumeEnabled()

Implements abstract io.rsocket.ConnectionSetupPayload.isResumeEnabled.

Annotations
@Override
keepAliveIntervalback to summary
public int keepAliveInterval()

Implements abstract io.rsocket.ConnectionSetupPayload.keepAliveInterval.

Annotations
@Override
keepAliveMaxLifetimeback to summary
public int keepAliveMaxLifetime()

Implements abstract io.rsocket.ConnectionSetupPayload.keepAliveMaxLifetime.

Annotations
@Override
metadataback to summary
public ByteBuf metadata()

Implements io.rsocket.Payload.metadata.

Doc from io.rsocket.Payload.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:ByteBuf

metadata as a bytebuf or slice of the metadata

Annotations
@Override
metadataMimeTypeback to summary
public String metadataMimeType()

Implements abstract io.rsocket.ConnectionSetupPayload.metadataMimeType.

Annotations
@Override
resumeTokenback to summary
public ByteBuf resumeToken()

Implements abstract io.rsocket.ConnectionSetupPayload.resumeToken.

Annotations
@Override
sliceDataback to summary
public ByteBuf sliceData()

Implements io.rsocket.Payload.sliceData.

Doc from io.rsocket.Payload.sliceData.

Returns the Payload data. Always non-null.

Returns:ByteBuf

payload data.

Annotations
@Override
sliceMetadataback to summary
public ByteBuf sliceMetadata()

Implements io.rsocket.Payload.sliceMetadata.

Doc from io.rsocket.Payload.sliceMetadata.

Returns a slice Payload metadata. Always non-null, check hasMetadata() to differentiate null from "".

Returns:ByteBuf

payload metadata.

Annotations
@Override
touchback to summary
public ConnectionSetupPayload touch()

Implements abstract io.rsocket.ConnectionSetupPayload.touch.

Implements io.rsocket.Payload.touch, io.netty.util.ReferenceCounted.touch.

Doc from io.rsocket.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).

Annotations
@Override
touchback to summary
public ConnectionSetupPayload touch(Object hint)

Implements io.rsocket.Payload.touch, io.netty.util.ReferenceCounted.touch.

Doc from io.rsocket.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 ResourceLeakDetector.

Annotations
@Override
willClientHonorLeaseback to summary
public boolean willClientHonorLease()

Implements abstract io.rsocket.ConnectionSetupPayload.willClientHonorLease.

Annotations
@Override