Package org.eclipse.jetty.websocket.common.extensions

Class FrameCaptureExtension

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.websocket.common.extensions.AbstractExtension

org.eclipse.jetty.websocket.common.extensions.FrameCaptureExtension

All Implemented Interfaces:

org.eclipse.jetty.util.component.LifeCycle, Extension, IncomingFrames, OutgoingFrames

public class FrameCaptureExtension
extends AbstractExtension

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
private static int	BUFSIZE
private Generator	generator
private java.nio.channels.SeekableByteChannel	incomingChannel
private java.util.concurrent.atomic.AtomicInteger	incomingCount
private java.nio.file.Path	incomingFramesPath
private static org.eclipse.jetty.util.log.Logger	LOG
private java.nio.channels.SeekableByteChannel	outgoingChannel
private java.util.concurrent.atomic.AtomicInteger	outgoingCount
private java.nio.file.Path	outgoingFramesPath
private java.nio.file.Path	outputDir
private java.lang.String	prefix

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
FrameCaptureExtension()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	The Sec-WebSocket-Extensions name for this extension.
void	incomingFrame(Frame frame)	Process the incoming frame.
void	outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)	A frame, and optional callback, intended for the network layer.
private void	saveFrame(Frame frame, boolean outgoing)
void	setConfig(ExtensionConfig config)

Methods inherited from class org.eclipse.jetty.websocket.common.extensions.AbstractExtension

getBufferPool, getConfig, getConnection, getNextIncoming, getNextOutgoing, getPolicy, init, init, isRsv1User, isRsv2User, isRsv3User, nextIncomingFrame, nextOutgoingFrame, setBufferPool, setConnection, setNextIncomingFrames, setNextOutgoingFrames, setPolicy, toString

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, doStart, doStop, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

BUFSIZE

private static final int BUFSIZE

See Also:

Constant Field Values

generator

private Generator generator

outputDir

private java.nio.file.Path outputDir

prefix

private java.lang.String prefix

incomingFramesPath

private java.nio.file.Path incomingFramesPath

outgoingFramesPath

private java.nio.file.Path outgoingFramesPath

incomingCount

private java.util.concurrent.atomic.AtomicInteger incomingCount

outgoingCount

private java.util.concurrent.atomic.AtomicInteger outgoingCount

incomingChannel

private java.nio.channels.SeekableByteChannel incomingChannel

outgoingChannel

private java.nio.channels.SeekableByteChannel outgoingChannel

Constructor Detail

FrameCaptureExtension

public FrameCaptureExtension()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Extension

The Sec-WebSocket-Extensions name for this extension.

Also known as the extension-token per Section 9.1. Negotiating Extensions.

Specified by:

getName in interface Extension

Overrides:

getName in class AbstractExtension

Returns:

the name of the extension

incomingFrame

public void incomingFrame(Frame frame)

Description copied from interface: IncomingFrames

Process the incoming frame.

Note: if you need to hang onto any information from the frame, be sure to copy it, as the information contained in the Frame will be released and/or reused by the implementation.

Parameters:

frame - the frame to process

outgoingFrame

public void outgoingFrame(Frame frame,
                          WriteCallback callback,
                          BatchMode batchMode)

Description copied from interface: OutgoingFrames

A frame, and optional callback, intended for the network layer.

Note: the frame can undergo many transformations in the various layers and extensions present in the implementation.

If you are implementing a mutation, you are obliged to handle the incoming WriteCallback appropriately.

Parameters:

frame - the frame to eventually write to the network layer.

callback - the callback to notify when the frame is written.

batchMode - the batch mode requested by the sender.

saveFrame

private void saveFrame(Frame frame,
                       boolean outgoing)

setConfig

public void setConfig(ExtensionConfig config)

Overrides:

setConfig in class AbstractExtension