org.eclipse.jetty.websocket
Class AbstractExtension

java.lang.Object
  org.eclipse.jetty.websocket.AbstractExtension

All Implemented Interfaces:

Extension, WebSocketGenerator, WebSocketParser.FrameHandler

Direct Known Subclasses:

DeflateFrameExtension, FragmentExtension, IdentityExtension

public class AbstractExtension
extends Object
implements Extension

Constructor Summary

AbstractExtension(String name, int dataCodes, int controlCodes, int flags)

Method Summary

void	addFrame(byte flags, byte opcode, byte[] content, int offset, int length)
void	bind(WebSocket.FrameConnection connection, WebSocketParser.FrameHandler incoming, WebSocketGenerator outgoing, byte[] dataOpcodes, byte[] controlOpcodes, byte[] bitMasks)
byte	clearFlag(byte flags, int flag)
void	close(int code, String message)
int	controlIndex(byte op)
byte	controlOpcode(int i)
int	dataIndex(byte op)
byte	dataOpcode(int i)
int	flush()
WebSocket.FrameConnection	getConnection()
int	getControlOpcodes()
int	getDataOpcodes()
String	getInitParameter(String name)
int	getInitParameter(String name, int dft)
String	getInitParameter(String name, String dft)
String	getName()
String	getParameterizedName()
int	getReservedBits()
boolean	init(Map<String,String> parameters)
boolean	isBufferEmpty()
boolean	isFlag(byte flags, int flag)
void	onFrame(byte flags, byte opcode, Buffer buffer)
byte	setFlag(byte flags, int flag)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExtension

public AbstractExtension(String name,
                         int dataCodes,
                         int controlCodes,
                         int flags)

Method Detail

getDataOpcodes

public int getDataOpcodes()

Specified by:

getDataOpcodes in interface Extension

getControlOpcodes

public int getControlOpcodes()

Specified by:

getControlOpcodes in interface Extension

getReservedBits

public int getReservedBits()

Specified by:

getReservedBits in interface Extension

getConnection

public WebSocket.FrameConnection getConnection()

init

public boolean init(Map<String,String> parameters)

Specified by:

init in interface Extension

getInitParameter

public String getInitParameter(String name)

getInitParameter

public String getInitParameter(String name,
                               String dft)

getInitParameter

public int getInitParameter(String name,
                            int dft)

bind

public void bind(WebSocket.FrameConnection connection,
                 WebSocketParser.FrameHandler incoming,
                 WebSocketGenerator outgoing,
                 byte[] dataOpcodes,
                 byte[] controlOpcodes,
                 byte[] bitMasks)

Specified by:

bind in interface Extension

getName

public String getName()

Specified by:

getName in interface Extension

getParameterizedName

public String getParameterizedName()

Specified by:

getParameterizedName in interface Extension

onFrame

public void onFrame(byte flags,
                    byte opcode,
                    Buffer buffer)

Specified by:

onFrame in interface WebSocketParser.FrameHandler

close

public void close(int code,
                  String message)

Specified by:

close in interface WebSocketParser.FrameHandler

flush

public int flush()
          throws IOException

Specified by:

flush in interface WebSocketGenerator

Throws:

IOException

isBufferEmpty

public boolean isBufferEmpty()

Specified by:

isBufferEmpty in interface WebSocketGenerator

addFrame

public void addFrame(byte flags,
                     byte opcode,
                     byte[] content,
                     int offset,
                     int length)
              throws IOException

Specified by:

addFrame in interface WebSocketGenerator

Throws:

IOException

dataOpcode

public byte dataOpcode(int i)

dataIndex

public int dataIndex(byte op)

controlOpcode

public byte controlOpcode(int i)

controlIndex

public int controlIndex(byte op)

setFlag

public byte setFlag(byte flags,
                    int flag)

clearFlag

public byte clearFlag(byte flags,
                      int flag)

isFlag

public boolean isFlag(byte flags,
                      int flag)

toString

public String toString()

Overrides:

toString in class Object