io.reactivex.netty.examples.http.ws.messaging

Class MessageFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.http.websocketx.WebSocketFrame

io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame

io.reactivex.netty.examples.http.ws.messaging.MessageFrame

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted

public class MessageFrame
extends io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame

Messaging frame used by MessagingClient and MessagingServer. This frame has two information:

• MessageFrame.MessageType for the message: This is the first byte in the frame data.
• Id for the message: This is a long after the first type byte.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageFrame.MessageType

Constructor Summary

Constructors

Constructor and Description
MessageFrame(io.netty.buffer.ByteBuf binaryData) Creates a new frame from existing data, usually used for reading a frame of the wire.
MessageFrame(MessageFrame.MessageType type, long id) Constructs a new frame, usually used for writing with the passed message type and id.
MessageFrame(MessageFrame.MessageType type, long id, io.netty.buffer.ByteBufAllocator allocator) Constructs a new frame, usually used for writing with the passed message type and id.

Method Summary

Modifier and Type	Method and Description
long	getId()
MessageFrame.MessageType	getType()
java.lang.String	toString()

Methods inherited from class io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame

copy, duplicate, replace, retain, retain, retainedDuplicate, touch, touch

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageFrame

public MessageFrame(MessageFrame.MessageType type,
                    long id)

Constructs a new frame, usually used for writing with the passed message type and id.

Parameters:

type - Type of the message.

id - Id of the message.

MessageFrame

public MessageFrame(MessageFrame.MessageType type,
                    long id,
                    io.netty.buffer.ByteBufAllocator allocator)

Constructs a new frame, usually used for writing with the passed message type and id.

Parameters:

type - Type of the message.

id - Id of the message.

allocator - An allocator for allocating the buffer for this frame.

MessageFrame

public MessageFrame(io.netty.buffer.ByteBuf binaryData)

Creates a new frame from existing data, usually used for reading a frame of the wire.

Parameters:

binaryData - Data representing a message frame.

Throws:

java.lang.IllegalArgumentException - If the message type is unknown.

java.lang.IndexOutOfBoundsException - If the frame is malformed and does not contain the data in the format required.

Method Detail

getId

public long getId()

getType

public MessageFrame.MessageType getType()

toString

public java.lang.String toString()

Overrides:

toString in class io.netty.handler.codec.http.websocketx.WebSocketFrame