001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.wireformat;
018
019import java.io.DataInput;
020import java.io.DataOutput;
021import java.io.IOException;
022
023import org.apache.activemq.util.ByteSequence;
024
025
026/**
027 * Provides a mechanism to marshal commands into and out of packets
028 * or into and out of streams, Channels and Datagrams.
029 *
030 * 
031 */
032public interface WireFormat {
033
034    /**
035     * Packet based marshaling 
036     */
037    ByteSequence marshal(Object command) throws IOException;
038    
039    /**
040     * Packet based un-marshaling 
041     */
042    Object unmarshal(ByteSequence packet) throws IOException;
043
044    /**
045     * Stream based marshaling 
046     */
047    void marshal(Object command, DataOutput out) throws IOException;
048    
049    /**
050     * Packet based un-marshaling 
051     */
052    Object unmarshal(DataInput in) throws IOException;
053    
054    /**
055     * @param the version of the wire format
056     */
057    void setVersion(int version);
058    
059    /**
060     * @return the version of the wire format
061     */
062    int getVersion();
063    
064}