|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.activemq.io.AbstractWireFormat
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 | |
protected boolean |
cachingEnabled
|
protected java.io.DataInputStream |
transportDataIn
|
protected java.io.DataOutputStream |
transportDataOut
|
| Fields inherited from interface org.activemq.io.WireFormat |
DEFAULT_MAXIMUM_MESSAGE_SIZE |
| Constructor Summary | |
AbstractWireFormat()
|
|
| Method Summary | |
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[] |
java.io.DataInputStream |
getTransportDataIn()
|
java.io.DataOutputStream |
getTransportDataOut()
|
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 dataIn)
Reads a packet from the given input stream |
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)
|
void |
setTransportDataIn(java.io.DataInputStream transportDataIn)
|
void |
setTransportDataOut(java.io.DataOutputStream transportDataOut)
|
byte[] |
toBytes(Packet packet)
A helper method which converts a packet into a byte array |
java.net.DatagramPacket |
writePacket(java.lang.String channelID,
Packet packet)
Writes the given package to a new datagram |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.activemq.io.WireFormat |
canProcessWireFormatVersion, copy, getCurrentWireFormatVersion, readPacket, writePacket |
| Field Detail |
protected java.io.DataOutputStream transportDataOut
protected java.io.DataInputStream transportDataIn
protected boolean cachingEnabled
| Constructor Detail |
public AbstractWireFormat()
| Method Detail |
public Packet readPacket(java.lang.String channelID,
java.net.DatagramPacket dpacket)
throws java.io.IOException
readPacket in interface WireFormatchannelID - is the unique channel IDdpacket -
java.io.IOException
public java.net.DatagramPacket writePacket(java.lang.String channelID,
Packet packet)
throws java.io.IOException,
javax.jms.JMSException
writePacket in interface WireFormatchannelID - is the unique channel IDpacket - is the packet to write
javax.jms.JMSException
java.io.IOException
public Packet fromBytes(byte[] bytes,
int offset,
int length)
throws java.io.IOException
fromBytes in interface WireFormatbytes - offset - length -
java.io.IOException
public Packet fromBytes(byte[] bytes)
throws java.io.IOException
fromBytes in interface WireFormatbytes -
java.io.IOException
public byte[] toBytes(Packet packet)
throws java.io.IOException,
javax.jms.JMSException
toBytes in interface WireFormatpacket -
java.io.IOException
javax.jms.JMSException
public void registerTransportStreams(java.io.DataOutputStream dataOut,
java.io.DataInputStream dataIn)
registerTransportStreams in interface WireFormatdataOut - dataIn -
public void initiateClientSideProtocol()
throws java.io.IOException
initiateClientSideProtocol in interface WireFormatjava.io.IOException
public void initiateServerSideProtocol()
throws java.io.IOException
initiateServerSideProtocol in interface WireFormatjava.io.IOExceptionpublic boolean isCachingEnabled()
isCachingEnabled in interface WireFormatpublic void setCachingEnabled(boolean enableCaching)
setCachingEnabled in interface WireFormatenableCaching - The enableCaching to set.public boolean doesSupportMessageFragmentation()
doesSupportMessageFragmentation in interface WireFormatpublic boolean doesSupportMessageCompression()
doesSupportMessageCompression in interface WireFormatpublic java.io.DataOutputStream getTransportDataOut()
public void setTransportDataOut(java.io.DataOutputStream transportDataOut)
transportDataOut - The transportDataOut to set.public java.io.DataInputStream getTransportDataIn()
public void setTransportDataIn(java.io.DataInputStream transportDataIn)
transportDataIn - The transportDataIn to set.
public Packet readPacket(java.io.DataInput dataIn)
throws java.io.IOException
WireFormat
readPacket in interface WireFormatdataIn -
java.io.IOException
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||