IControlDatagram.java :  » JMS » UberMQ » com » ubermq » jms » common » datagram » Java Open Source

package com.ubermq.jms.common.datagram;

import com.ubermq.jms.common.datagram.control.ICommandSubGram;
import com.ubermq.kernel.IDatagram;

/**
 * A datagram for controlling aspects of the current connection. Each control
 * datagram contains a specific command, which is indicated by a control code
 * and an implementation of <code>ICommandSubGram</code>.
 * @see com.ubermq.jms.server.datagram.control.ICommandSubGram
 */
public interface IControlDatagram extends IDatagram
{
    /**
     * Gets the control code.
   * @return a control code that is application specific.
     */
    public int getControlCode();
  
  /**
   * Gets the command that this control datagram represents.
   * @see com.ubermq.jms.common.datagram.control.ICommandSubGram
   */
  public ICommandSubGram getCommandSubGram();
}