WireFormat


1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one or more
4    * contributor license agreements.  See the NOTICE file distributed with
5    * this work for additional information regarding copyright ownership.
6    * The ASF licenses this file to You under the Apache License, Version 2.0
7    * (the "License"); you may not use this file except in compliance with
8    * the License.  You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.activemq.wireformat;
19  
20  import java.io.DataInput  ;
21  import java.io.DataOutput  ;
22  import java.io.IOException  ;
23  
24  import org.apache.activemq.util.ByteSequence;
25  
26  
27  /**
28   * Provides a mechanism to marshal commands into and out of packets
29   * or into and out of streams, Channels and Datagrams.
30   *
31   * @version $Revision: 1.1 $
32   */
33  public interface WireFormat {
34  
35      /**
36       * Packet based marshaling 
37       */
38      ByteSequence marshal(Object   command) throws IOException  ;
39      
40      /**
41       * Packet based un-marshaling 
42       */
43      Object   unmarshal(ByteSequence packet) throws IOException  ;
44  
45      /**
46       * Stream based marshaling 
47       */
48      void marshal(Object   command, DataOutput   out) throws IOException  ;
49      
50      /**
51       * Packet based un-marshaling 
52       */
53      Object   unmarshal(DataInput   in) throws IOException  ;
54      
55      /**
56       * @param the version of the wire format
57       */
58      public void setVersion(int version);
59      
60      /**
61       * @return the version of the wire format
62       */
63      public int getVersion();
64      
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags