payload

Documentation

Index

• func Equal(a Payload, b Payload) bool
• type Payload
  • func Clone(payload Payload) Payload
  • func MustNewFile(filename string, metadata []byte) Payload
  • func New(data []byte, metadata []byte) Payload
  • func NewFile(filename string, metadata []byte) (Payload, error)
  • func NewString(data, metadata string) Payload
• type SetupPayload

Functions

func Equal

func Equal(a Payload, b Payload) bool

Equal returns true if payloads have same data and metadata.

Types

type Payload

type Payload interface {
	// Metadata returns raw metadata bytes.
	// The ok result indicates whether metadata exists.
	Metadata() (metadata []byte, ok bool)
	// MetadataUTF8 returns metadata as UTF8 string.
	// The ok result indicates whether metadata exists.
	MetadataUTF8() (metadata string, ok bool)
	// Data returns raw data bytes.
	Data() []byte
	// DataUTF8 returns data as UTF8 string.
	DataUTF8() string
}

Payload is a stream message (upstream or downstream). It contains data associated with a stream created by a previous request. In Reactive Streams and Rx this is the 'onNext' event.

func Clone

func Clone(payload Payload) Payload

Clone create a copy of original payload.

func MustNewFile

func MustNewFile(filename string, metadata []byte) Payload

MustNewFile create a new payload from file.

func New

func New(data []byte, metadata []byte) Payload

New create a new payload with bytes.

func NewFile

func NewFile(filename string, metadata []byte) (Payload, error)

NewFile create a new payload from file.

func NewString

func NewString(data, metadata string) Payload

NewString create a new payload with strings.

type SetupPayload

type SetupPayload interface {
	Payload
	// DataMimeType returns MIME type of data.
	DataMimeType() string
	// MetadataMimeType returns MIME type of metadata.
	MetadataMimeType() string
	// TimeBetweenKeepalive returns interval duration of keepalive.
	TimeBetweenKeepalive() time.Duration
	// MaxLifetime returns max lifetime of RSocket connection.
	MaxLifetime() time.Duration
	// Version return RSocket protocol version.
	Version() core.Version
}

SetupPayload is particular payload for RSocket Setup.