wvlet.airframe.msgpack.spi

Attributes

Members list

Concise view

Type members

Classlikes

trait Buffer

Buffer interface, which does not have any internal cursors unlike ByteBuffer of Java library.

Buffer interface, which does not have any internal cursors unlike ByteBuffer of Java library.

  • The read methods read the buffer data from the given position.
  • The write methods write data to the specified position in the buffer and return the written byte length.

If the buffer capacity is insufficient, these read/write methods throw an InsufficientBufferException. If this exception is thrown, the user code should feed more data, and then resume reading.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BufferPacker extends Packer

Attributes

Graph
Supertypes
trait Packer
trait AutoCloseable
class Object
trait Matchable
class Any
Known subtypes
object Code

MessagePack prefix codes

MessagePack prefix codes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Code.type
object Compat

For compatibility with Scala, Scala.js

For compatibility with Scala, Scala.js

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Compat.type
trait ErrorCode

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ErrorCode

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ExtTypeHeader(extType: Byte, byteLength: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class InsufficientBufferException(currentPosition: Long, expectedLength: Long) extends MessageException

Attributes

Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
case class IntegerOverflowException(bigInteger: BigInteger) extends MessageException

This error is thrown when the user tries to read an integer value using a smaller types. For example, calling MessageUnpacker.unpackInt() for an integer value that is larger than Integer.MAX_VALUE will cause this exception.

This error is thrown when the user tries to read an integer value using a smaller types. For example, calling MessageUnpacker.unpackInt() for an integer value that is larger than Integer.MAX_VALUE will cause this exception.

Attributes

Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
class MessageException(val errorCode: ErrorCode, message: String, cause: Throwable) extends Exception

Base class for message pack errors

Base class for message pack errors

Attributes

Companion:
object
Graph
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class MessageFormat(val valueType: ValueType)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ARRAY16.type
object ARRAY32.type
object BIN16.type
object BIN32.type
object BIN8.type
object BOOLEAN.type
object EXT16.type
object EXT32.type
object EXT8.type
object FIXARRAY.type
object FIXEXT1.type
object FIXEXT16.type
object FIXEXT2.type
object FIXEXT4.type
object FIXEXT8.type
object FIXMAP.type
object FIXSTR.type
object FLOAT32.type
object FLOAT64.type
object INT16.type
object INT32.type
object INT64.type
object INT8.type
object MAP16.type
object MAP32.type
object NEGFIXINT.type
object NEVER_USED.type
object NIL.type
object POSFIXINT.type
object STR16.type
object STR32.type
object STR8.type
object UINT16.type
object UINT32.type
object UINT64.type
object UINT8.type

Describes the list of the message format types defined in the MessagePack specification.

Describes the list of the message format types defined in the MessagePack specification.

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait MessageSink extends AutoCloseable with Flushable

Provides a buffered output stream that writes sequence of WriteBuffer instances.

Provides a buffered output stream that writes sequence of WriteBuffer instances.

A Sink implementation has total control of the buffer memory so that it can reuse buffer memory, use buffer pools, or use memory-mapped files.

Attributes

Graph
Supertypes
trait Flushable
trait AutoCloseable
class Object
trait Matchable
class Any
trait MessageSource extends AutoCloseable

Attributes

Graph
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any

Write MessagePack code at a given position on the buffer and return the written byte length

Write MessagePack code at a given position on the buffer and return the written byte length

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Read a message pack data from a given offset in the buffer. The last read byte length can be checked by calling ReadCursor.lastReadLength method.

Read a message pack data from a given offset in the buffer. The last read byte length can be checked by calling ReadCursor.lastReadLength method.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait Packer extends AutoCloseable

Message Packer interface

Message Packer interface

Attributes

Graph
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
Known subtypes
trait ReadBuffer extends Buffer

Attributes

Graph
Supertypes
trait Buffer
class Object
trait Matchable
class Any
Known subtypes
case class ReadCursor(var buf: ReadBuffer, var position: Int)

Mutable cursor for Unpacker.

Mutable cursor for Unpacker.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class TooLargeMessageException(size: Long) extends MessageException

Attributes

Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
trait Unpacker extends AutoCloseable

MessageUnpacker interface

MessageUnpacker interface

Attributes

Graph
Supertypes
trait AutoCloseable
class Object
trait Matchable
class Any
Known subtypes
trait Value

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Value

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Value.type

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class ValueType(val isNumber: Boolean, val isRaw: Boolean)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ARRAY.type
object BINARY.type
object BOOLEAN.type
object EXTENSION.type
object FLOAT.type
object INTEGER.type
object MAP.type
object NIL.type
object STRING.type
object ValueType

Representation of MessagePack value types.

Representation of MessagePack value types.

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait WriteBuffer extends Buffer

Attributes

Graph
Supertypes
trait Buffer
class Object
trait Matchable
class Any
Known subtypes
case class WriteCursor(var buf: WriteBuffer, var position: Int)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Types

type MsgPack = Array[Byte]