summaryrefslogtreecommitdiff
path: root/java/src/MessageType.java
blob: 2443ec38a67e033f684a3c22b665f054c689675a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*************************************************
 *
 * = PACKAGE
 *    ACE.ASX
 *
 * = FILENAME
 *    MessageType.java
 *
 *@author Prashant Jain
 *
 *************************************************/
package ACE.ASX;

/**
 * <hr>
 * <h2>SYNOPSIS</h2>
 *<blockquote>
 *     Message types used by ACE.MessageBlock.
 *</blockquote>
 *
 * <h2>DESCRIPTION</h2>
 *<blockquote>
 *     Defines bit masks used to identify various types of messages.
 *</blockquote>
 *
 *<h2>NOTES</h2>
 *<blockquote>
 * This class is not intended to be instantiable.
 *</blockquote>
 */
public class MessageType
{
  // = Data and protocol messages (regular and priority)
  /** regular data */
  public static final int MB_DATA     = 0x01;

  /** protocol control */
  public static final int MB_PROTO    = 0x02;

  /** regular data */
  public static final int MB_OBJECT   = 0x09;


  // = Control messages (regular and priority)
  /** line break */
  public static final int MB_BREAK    = 0x03;

  /** pass file pointer */
  public static final int MB_PASSFP   = 0x04;

  /** post an event to an event queue */
  public static final int MB_EVENT    = 0x05;

  /** generate process signal */
  public static final int MB_SIG      = 0x06;

  /** ioctl; set/get params */
  public static final int MB_IOCTL    = 0x07;

  /** set various stream head options */
  public static final int MB_SETOPTS  = 0x08; 


  // = Control messages (high priority; go to head of queue)
  /** acknowledge ioctl */
  public static final int MB_IOCACK   = 0x81;

  /** negative ioctl acknowledge */
  public static final int MB_IOCNAK   = 0x82;

  /** priority proto message */
  public static final int MB_PCPROTO  = 0x83;

  /** generate process signal */
  public static final int MB_PCSIG    = 0x84;

  /** generate read notification */
  public static final int MB_READ     = 0x85;

  /** flush your queues */
  public static final int MB_FLUSH    = 0x86;

  /** stop transmission immediately */
  public static final int MB_STOP     = 0x87;

  /** restart transmission after stop */
  public static final int MB_START    = 0x88;

  /** line disconnect */
  public static final int MB_HANGUP   = 0x89;

  /** fatal error used to set u.u_error */
  public static final int MB_ERROR    = 0x8a;

  /** post an event to an event queue */
  public static final int MB_PCEVENT  = 0x8b; 


  /** Normal priority messages */
  public static final int MB_NORMAL   = 0x00;

  /** High priority control messages */
  public static final int MB_PRIORITY = 0x80; 

  // Default private constructor to avoid instantiation
  private MessageType ()
  {
  }
}