01 /*
02 *
03 * Licensed to the Apache Software Foundation (ASF) under one
04 * or more contributor license agreements. See the NOTICE file
05 * distributed with this work for additional information
06 * regarding copyright ownership. The ASF licenses this file
07 * to you under the Apache License, Version 2.0 (the
08 * "License"); you may not use this file except in compliance
09 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 */
21 package org.apache.qpid.protocol;
22
23 import org.apache.qpid.framing.AMQDataBlock;
24
25 /**
26 * AMQProtocolWriter provides a method to write a frame of data 'to the wire', in the context of the object
27 * that implements the method, usually some sort of session. The block of data, encapsulated by {@link AMQDataBlock},
28 * will be encoded as it is written.
29 *
30 * <p/><table id="crc"><caption>CRC Card</caption>
31 * <tr><th> Responsibilities
32 * <tr><td> Write an encoded block of data to the write, in the context of a session.
33 * </table>
34 */
35 public interface AMQProtocolWriter
36 {
37 /**
38 * Writes a frame to the wire, encoding it as necessary, for example, into a sequence of bytes.
39 *
40 * @param frame The frame to be encoded and written.
41 */
42 public void writeFrame(AMQDataBlock frame);
43 }
|