Packages

trait PacketCodec extends AnyRef

Self Type
PacketCodec
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PacketCodec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def charsetName: String

    The character set used to encode and decode strings.

    The character set used to encode and decode strings. Unfortunately, this has not been specified in the OSC standard. We recommend to either restrict characters to 7-bit ascii range or to use UTF-8. The default implementation initially uses UTF-8.

  2. abstract def decodeMessage(name: String, b: ByteBuffer): Message

    Decodes a message with a given name and buffer holding its arguments.

    Decodes a message with a given name and buffer holding its arguments.

    Implementations should be careful to catch potential instances of BufferUnderflowException or other runtime exception such as IllegalArgumentException and cast them into instances of PacketCodec.Exception, such that the caller can be safe to catch any error by matching against PacketCodec.Exception.

    name

    the name of the message which has already been decoded when this method is called.

    b

    the buffer, positioned at the type tags list (beginning with ',').

    Annotations
    @throws( classOf[Exception] )
  3. abstract def encodeBundle(bndl: Bundle, b: ByteBuffer): Unit

    Encodes the given bundle into the provided ByteBuffer, beginning at the buffer's current position.

    Encodes the given bundle into the provided ByteBuffer, beginning at the buffer's current position. To write the encoded packet, you will typically call flip() on the buffer, then write() on the channel.

    b

    ByteBuffer pointing right at the beginning of the osc packet. buffer position will be right after the end of the packet when the method returns.

    Annotations
    @throws( classOf[IOException] )
  4. abstract def encodeMessage(msg: Message, b: ByteBuffer): Unit

    Encodes the message onto the given ByteBuffer, beginning at the buffer's current position.

    Encodes the message onto the given ByteBuffer, beginning at the buffer's current position. To write the encoded message, you will typically call flip() on the buffer, then write() on the channel.

    b

    ByteBuffer pointing right at the beginning of the osc packet. buffer position will be right after the end of the message when the method returns.

    Annotations
    @throws( classOf[Exception] )
  5. abstract def encodedMessageSize(msg: Message): Int

    Calculates the byte size of the encoded message

    Calculates the byte size of the encoded message

    returns

    the size of the OSC message in bytes

  6. abstract def printAtom(value: Any, stream: PrintStream, nestCount: Int): Unit

    Prints a textual representation of the given atom to the given print stream.

    Prints a textual representation of the given atom to the given print stream. Implementations should use the atom encoder suitable for the given value.

    value

    the atom to encode

    stream

    the stream to print on

    nestCount

    should only be used if the printing requires line breaks. Indentation should be 2x nestCount space characters.

    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def decode(b: ByteBuffer): Packet

    Creates a new packet decoded from the ByteBuffer.

    Creates a new packet decoded from the ByteBuffer. This method tries to read a null terminated string at the beginning of the provided buffer. If it equals the bundle identifier, the decode of Bundle is called (which may recursively decode nested bundles), otherwise the one from Message.

    This method is final. For messages encountered, decodeMessage is called, , thus for implementations of PacketCodec, it is sufficient to overwrite decodeMessage.

    b

    ByteBuffer pointing right at the beginning of the packet. the buffer's limited should be set appropriately to allow the complete packet to be read. when the method returns, the buffer's position is right after the end of the packet.

    returns

    new decoded OSC packet

    Annotations
    @throws( classOf[Exception] )
  7. final def decodeBundle(b: ByteBuffer): Bundle
    Annotations
    @throws( classOf[Exception] )
  8. final def encodedBundleSize(bndl: Bundle): Int

    Calculates the byte size of the encoded bundle.

    Calculates the byte size of the encoded bundle. This method is final. The size is the sum of the bundle name, its timetag and the sizes of each bundle element.

    For contained messages, encodedMessageSize will be called, thus for implementations of PacketCodec, it is sufficient to overwrite encodedMessageSize.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped