|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a strategy of encoding packets on the wire or on disk using some kind of serialization or wire format.
We use a default efficient format for Java to Java communication but other formats to other systems can be used, such as using simple text strings when talking to JavaScript or coming up with other formats for talking to C / C# languages or proprietary messaging systems we wish to interface with at the wire level etc.
Field Summary | |
static int |
DEFAULT_MAXIMUM_MESSAGE_SIZE
The maximum message size supported by the transport If the message is bigger than this size, then the message will be 'chunked' into separate pieces and re-assembled on the consumer |
Method Summary | |
boolean |
canProcessWireFormatVersion(int version)
Can this wireformat process packets of this version |
WireFormat |
copy()
Creates a new copy of this wire format so it can be used in another thread/context |
boolean |
doesSupportMessageCompression()
Some wire formats will not be able to understand compressed messages |
boolean |
doesSupportMessageFragmentation()
some wire formats will implement their own fragementation |
Packet |
fromBytes(byte[] bytes)
Reads the packet from the given byte[] |
Packet |
fromBytes(byte[] bytes,
int offset,
int length)
Reads the packet from the given byte[] |
int |
getCurrentWireFormatVersion()
|
void |
initiateClientSideProtocol()
Some wire formats require a handshake at start-up |
void |
initiateServerSideProtocol()
Some wire formats require a handshake at start-up |
boolean |
isCachingEnabled()
|
Packet |
readPacket(java.io.DataInput in)
Reads a packet from the given input stream |
Packet |
readPacket(int firstByte,
java.io.DataInput in)
A helper method for working with sockets where the first byte is read first, then the rest of the message is read. |
Packet |
readPacket(java.lang.String channelID,
java.net.DatagramPacket dpacket)
Read a packet from a Datagram packet from the given channelID. |
void |
registerTransportStreams(java.io.DataOutputStream dataOut,
java.io.DataInputStream dataIn)
some transports may register their streams (e.g. |
void |
setCachingEnabled(boolean enableCaching)
|
byte[] |
toBytes(Packet packet)
A helper method which converts a packet into a byte array |
Packet |
writePacket(Packet packet,
java.io.DataOutput out)
Writes the packet to the given output stream |
java.net.DatagramPacket |
writePacket(java.lang.String channelID,
Packet packet)
Writes the given package to a new datagram |
Field Detail |
public static final int DEFAULT_MAXIMUM_MESSAGE_SIZE
Method Detail |
public Packet readPacket(java.io.DataInput in) throws java.io.IOException
in
-
java.io.IOException
public Packet readPacket(int firstByte, java.io.DataInput in) throws java.io.IOException
firstByte
- the first byte of the packetin
- the rest of the packet
java.io.IOException
public Packet readPacket(java.lang.String channelID, java.net.DatagramPacket dpacket) throws java.io.IOException
channelID
- is the unique channel IDdpacket
-
java.io.IOException
public Packet writePacket(Packet packet, java.io.DataOutput out) throws java.io.IOException, javax.jms.JMSException
packet
- out
-
java.io.IOException
javax.jms.JMSException
public java.net.DatagramPacket writePacket(java.lang.String channelID, Packet packet) throws java.io.IOException, javax.jms.JMSException
channelID
- is the unique channel IDpacket
- is the packet to write
java.io.IOException
javax.jms.JMSException
public Packet fromBytes(byte[] bytes, int offset, int length) throws java.io.IOException
bytes
- offset
- length
-
java.io.IOException
public Packet fromBytes(byte[] bytes) throws java.io.IOException
bytes
-
java.io.IOException
public byte[] toBytes(Packet packet) throws java.io.IOException, javax.jms.JMSException
packet
-
java.io.IOException
javax.jms.JMSException
public WireFormat copy()
public boolean canProcessWireFormatVersion(int version)
version
- the version number to test
public int getCurrentWireFormatVersion()
public void registerTransportStreams(java.io.DataOutputStream dataOut, java.io.DataInputStream dataIn)
dataOut
- dataIn
- public void initiateClientSideProtocol() throws java.io.IOException
java.io.IOException
public void initiateServerSideProtocol() throws java.io.IOException
java.io.IOException
public boolean isCachingEnabled()
public void setCachingEnabled(boolean enableCaching)
enableCaching
- The enableCaching to set.public boolean doesSupportMessageFragmentation()
public boolean doesSupportMessageCompression()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |