|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.mina.filter.codec.ProtocolEncoderAdapter
org.apache.mina.filter.codec.prefixedstring.PrefixedStringEncoder
public class PrefixedStringEncoder
A ProtocolEncoder
which encodes a string
using a fixed-length length prefix.
Field Summary | |
---|---|
static int |
DEFAULT_MAX_DATA_LENGTH
|
static int |
DEFAULT_PREFIX_LENGTH
|
Constructor Summary | |
---|---|
PrefixedStringEncoder()
|
|
PrefixedStringEncoder(Charset charset)
|
|
PrefixedStringEncoder(Charset charset,
int prefixLength)
|
|
PrefixedStringEncoder(Charset charset,
int prefixLength,
int maxDataLength)
|
Method Summary | |
---|---|
void |
encode(IoSession session,
Object message,
ProtocolEncoderOutput out)
Encodes higher-level message objects into binary or protocol-specific data. |
int |
getMaxDataLength()
Gets the maximum number of bytes allowed for encoding a single String * |
int |
getPrefixLength()
Gets the length of the length prefix (1, 2, or 4) |
void |
setMaxDataLength(int maxDataLength)
Sets the maximum number of bytes allowed for encoding a single String (including the prefix) |
void |
setPrefixLength(int prefixLength)
Sets the number of bytes used by the length prefix |
Methods inherited from class org.apache.mina.filter.codec.ProtocolEncoderAdapter |
---|
dispose |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_PREFIX_LENGTH
public static final int DEFAULT_MAX_DATA_LENGTH
Constructor Detail |
---|
public PrefixedStringEncoder(Charset charset, int prefixLength, int maxDataLength)
public PrefixedStringEncoder(Charset charset, int prefixLength)
public PrefixedStringEncoder(Charset charset)
public PrefixedStringEncoder()
Method Detail |
---|
public void setPrefixLength(int prefixLength)
prefixLength
- the length of the length prefix (1, 2, or 4)public int getPrefixLength()
public void setMaxDataLength(int maxDataLength)
The encoder will throw a IllegalArgumentException
when more bytes
are needed to encode a String value.
The default value is DEFAULT_MAX_DATA_LENGTH
.
maxDataLength
- maximum number of bytes allowed for encoding a single Stringpublic int getMaxDataLength()
public void encode(IoSession session, Object message, ProtocolEncoderOutput out) throws Exception
ProtocolEncoder
ProtocolEncoder.encode(IoSession, Object, ProtocolEncoderOutput)
method with message which is popped from the session write queue, and then
the encoder implementation puts encoded messages (typically IoBuffer
s)
into ProtocolEncoderOutput
.
Exception
- if the message violated protocol specification
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |