Source code: org/activemq/io/impl/PacketWriter.java
1 /**
2 *
3 * Copyright 2004 Protique Ltd
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 **/
18
19
20 package org.activemq.io.impl;
21 import java.io.DataOutput;
22 import java.io.IOException;
23
24 import org.activemq.message.Packet;
25
26 /**
27 * Allows instances implementing Packet to written to a DataOutput
28 */
29
30 public interface PacketWriter {
31
32 /**
33 * Return the type of Packet
34 *
35 * @return integer representation of the type of Packet
36 */
37
38 public int getPacketType();
39
40 /**
41 * @param packet
42 * @return true if this PacketWriter can write this type of Packet
43 */
44 public boolean canWrite(Packet packet);
45
46 /**
47 * Write a Packet instance to data output stream
48 *
49 * @param packet the instance to be seralized
50 * @param dataOut the output stream
51 * @throws IOException thrown if an error occurs
52 */
53
54 public void writePacket(Packet packet, DataOutput dataOut) throws IOException;
55
56 /**
57 * Serializes a Packet int a byte array
58 *
59 * @param packet
60 * @return the byte[]
61 * @throws IOException
62 */
63
64 public byte[] writePacketToByteArray(Packet packet) throws IOException;
65
66 /**
67 * Set the wire format version
68 * @param version
69 */
70 public void setWireFormatVersion(int version);
71
72 /**
73 * @return the wire format version
74 */
75 public int getWireFormatVersion();
76
77
78 }