Modifier and Type	Class and Description
public static enum	TyrusFrame.FrameType An Enumeration of frame types.

Modifier and Type	Field and Description
private TyrusFrame.FrameType	frameType

Access	Constructor and Description
protected	TyrusFrame(Frame enriched frame. frame, TyrusFrame.FrameType type of the frame. frameType) Constructor.

Method Summary

Modifier and Type	Method and Description
public TyrusFrame.FrameType	Returns: type of the frame. getFrameType() Returns the type of the frame.
public abstract void	respond(TyrusWebSocket socket on which the appropriate action will be performed. socket) Execution part of frame processing.
public static TyrusFrame	Returns: new TyrusFrame. wrap(Frame original plain frame. frame, byte type of fragment (text or binary). inFragmentedType, ByteBuffer decoding remainder. Used only for partial text frames. remainder) `TyrusFrame` factory method.

Inherited from org.glassfish.tyrus.core.frame.Frame:: builder builder getMaskingKey getOpcode getPayloadData getPayloadLength isControlFrame isFin isMask isRsv1 isRsv2 isRsv3 toString

frameType	back to summary
private TyrusFrame.FrameType frameType

TyrusFrame	back to summary
protected TyrusFrame(Frame frame, TyrusFrame.FrameType frameType) Constructor. Parameters frame:Frame enriched frame. frameType:TyrusFrame.FrameType type of the frame.

Method Detail

getFrameType	back to summary
public TyrusFrame.FrameType getFrameType() Returns the type of the frame. It is used for distinguishing frame types in monitoring. Todo consider moving this to "MonitoredFrame" or something like this; Returns:TyrusFrame.FrameType type of the frame.

getFrameType

back to summary

public TyrusFrame.FrameType getFrameType()

Returns the type of the frame. It is used for distinguishing frame types in monitoring.

Todo

consider moving this to "MonitoredFrame" or something like this;

Returns:TyrusFrame.FrameType: type of the frame.

respond	back to summary
public abstract void respond(TyrusWebSocket socket) Execution part of frame processing. Parameters socket:TyrusWebSocket socket on which the appropriate action will be performed.

respond

back to summary

public abstract void respond(TyrusWebSocket socket)

Execution part of frame processing.

Parameters

socket:TyrusWebSocket: socket on which the appropriate action will be performed.

wrap back to summary

wrap	back to summary
public static TyrusFrame wrap(Frame frame, byte inFragmentedType, ByteBuffer remainder) `TyrusFrame` factory method. Parameters frame:Frame original plain frame. inFragmentedType:byte type of fragment (text or binary). remainder:ByteBuffer decoding remainder. Used only for partial text frames. Returns:TyrusFrame new TyrusFrame.

public static TyrusFrame wrap(Frame frame, byte inFragmentedType, ByteBuffer remainder)

TyrusFrame factory method.

Parameters

frame:Frame: original plain frame.
inFragmentedType:byte: type of fragment (text or binary).
remainder:ByteBuffer: decoding remainder. Used only for partial text frames.

Returns:TyrusFrame

new TyrusFrame.

org.glassfish.tyrus.core.frame back to summary

public final Enum TyrusFrame.FrameType

Class Inheritance

extends Enum<TyrusFrame.FrameType>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.frame.TyrusFrame.FrameType

An Enumeration of frame types.

Field Summary

Modifier and Type	Field and Description
public static final TyrusFrame.FrameType	BINARY Binary frame.
public static final TyrusFrame.FrameType	BINARY_CONTINUATION Continuation binary frame.
public static final TyrusFrame.FrameType	CLOSE Close frame.
public static final TyrusFrame.FrameType	PING Ping frame.
public static final TyrusFrame.FrameType	PONG Pong frame.
public static final TyrusFrame.FrameType	TEXT Text frame.
public static final TyrusFrame.FrameType	TEXT_CONTINUATION Continuation text frame.

Constructor Summary

Access	Constructor and Description
private	FrameType()

Method Summary

Modifier and Type	Method and Description
public static TyrusFrame.FrameType	valueOf(String name)
public static TyrusFrame.FrameType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BINARY back to summary

BINARY	back to summary
public static final TyrusFrame.FrameType BINARY Binary frame. See Also `org.glassfish.tyrus.core.frame.BinaryFrame`

public static final TyrusFrame.FrameType BINARY

Binary frame.

See Also: org.glassfish.tyrus.core.frame.BinaryFrame

BINARY_CONTINUATION back to summary

BINARY_CONTINUATION	back to summary
public static final TyrusFrame.FrameType BINARY_CONTINUATION Continuation binary frame. See Also `org.glassfish.tyrus.core.frame.BinaryFrame`

public static final TyrusFrame.FrameType BINARY_CONTINUATION

Continuation binary frame.

See Also: org.glassfish.tyrus.core.frame.BinaryFrame

CLOSE back to summary

CLOSE	back to summary
public static final TyrusFrame.FrameType CLOSE Close frame. See Also `org.glassfish.tyrus.core.frame.CloseFrame`

public static final TyrusFrame.FrameType CLOSE

Close frame.

See Also: org.glassfish.tyrus.core.frame.CloseFrame

PING back to summary

PING	back to summary
public static final TyrusFrame.FrameType PING Ping frame. See Also `org.glassfish.tyrus.core.frame.PingFrame`

public static final TyrusFrame.FrameType PING

Ping frame.

See Also: org.glassfish.tyrus.core.frame.PingFrame

PONG back to summary

PONG	back to summary
public static final TyrusFrame.FrameType PONG Pong frame. See Also `org.glassfish.tyrus.core.frame.PongFrame`

public static final TyrusFrame.FrameType PONG

Pong frame.

See Also: org.glassfish.tyrus.core.frame.PongFrame

TEXT back to summary

TEXT	back to summary
public static final TyrusFrame.FrameType TEXT Text frame. See Also `org.glassfish.tyrus.core.frame.TextFrame`

public static final TyrusFrame.FrameType TEXT

Text frame.

See Also: org.glassfish.tyrus.core.frame.TextFrame

TEXT_CONTINUATION back to summary

TEXT_CONTINUATION	back to summary
public static final TyrusFrame.FrameType TEXT_CONTINUATION Continuation text frame. See Also `org.glassfish.tyrus.core.frame.TextFrame`

public static final TyrusFrame.FrameType TEXT_CONTINUATION

Continuation text frame.

See Also: org.glassfish.tyrus.core.frame.TextFrame

Constructor Detail

FrameType	back to summary
private FrameType()

Method Detail

valueOf	back to summary
public static TyrusFrame.FrameType valueOf(String name)

values	back to summary
public static TyrusFrame.FrameType[] values()

public abstract Class TyrusFrame

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TyrusFrame.FrameType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail