GazeProto (MGF Java client)

java.lang.Object
- TightVnc.RfbProto
- - GazeVnc.GazeProto

```
public class GazeProto
extends RfbProto
```

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static int`	`ANY_ID` Message destination Id.
`static int`	`gdControlMsg` Message types
`static int`	`gdDescription` gdTextMsg Message subtypes
`static int`	`gdGazeBlink` gdGazeMsg Message subtypes
`static int`	`gdGazeFixation` gdGazeMsg Message subtypes
`static int`	`gdGazeMsg` Message types
`static int`	`gdGazeSample` gdGazeMsg Message subtypes
`static int`	`gdName` gdTextMsg Message subtypes
`static int`	`gdPoke` gdControlMsg Message subtypes
`static int`	`gdRegister` gdControlMsg Message subtypes
`static int`	`gdText` gdTextMsg Message subtypes
`static int`	`gdTextMsg` Message types
`static int`	`gdUnregister` gdControlMsg Message subtypes
`(package private) static int`	`SERVER_ID` Message destination Id.
`short`	`srcClientId` Last received image source

Fields inherited from class TightVnc.RfbProto
AuthNone, AuthUnixLogin, AuthVNC, Bell, blueMax, blueShift, ClientCutText, clientMajor, clientMinor, copyRectSrcX, copyRectSrcY, desktopName, EncodingCompressLevel0, EncodingCopyRect, EncodingCoRRE, EncodingHextile, EncodingLastRect, EncodingNewFBSize, EncodingPointerPos, EncodingQualityLevel0, EncodingRaw, EncodingRichCursor, EncodingRRE, EncodingTight, EncodingXCursor, EncodingZlib, EncodingZRLE, FixColourMapEntries, framebufferHeight, FramebufferUpdate, FramebufferUpdateRequest, framebufferWidth, greenMax, greenShift, HextileAnySubrects, HextileBackgroundSpecified, HextileForegroundSpecified, HextileRaw, HextileSubrectsColoured, inlock, KeyboardEvent, MaxNormalEncoding, os, outlock, PointerEvent, redMax, redShift, SecTypeInvalid, SecTypeNone, SecTypeTight, SecTypeVncAuth, ServerCutText, serverMajor, serverMinor, SetColourMapEntries, SetEncodings, SetPixelFormat, SigAuthNone, SigAuthUnixLogin, SigAuthVNC, SigEncodingCompressLevel0, SigEncodingCopyRect, SigEncodingCoRRE, SigEncodingHextile, SigEncodingLastRect, SigEncodingNewFBSize, SigEncodingPointerPos, SigEncodingQualityLevel0, SigEncodingRaw, SigEncodingRichCursor, SigEncodingRRE, SigEncodingTight, SigEncodingXCursor, SigEncodingZlib, SigEncodingZRLE, updateNRects, updateRectEncoding, updateRectH, updateRectW, updateRectX, updateRectY

Constructor Summary

Constructors
Constructor and Description

GazeProto(java.lang.String h, int p, GazeVncViewer v)
Constructor

Constructors
Constructor and Description
`GazeProto(java.lang.String h, int p, GazeVncViewer v)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`private GazeEntryBlink`	`readBlink()` Read one blink structure
`java.util.Vector<GazeEntryBlink>`	`ReadBlinksMsg()` Read blinks message
`java.lang.String`	`ReadDescriptionMsg()` Read description message @throws IOException
`private GazeEntryFixation`	`readFixation()` Read one fixation structure
`java.util.Vector<GazeEntryFixation>`	`ReadFixationsMsg()` Read fixations message
`private int`	`readHeaderMsg()` Read income server message, heading a list of gaze data structures type and subtype already read
`java.lang.String`	`ReadNameMsg()` Read name message @throws IOException
`short`	`ReadPokeMsg()` Read register message @throws IOException
`short`	`ReadRegisterMsg()` Read register message @throws IOException
`private GazeEntrySample`	`readSample()` Read one sample structure
`java.util.Vector<GazeEntrySample>`	`ReadSamplesMsg()` Read single samples message
`int`	`readServerMessageSubtype()`
`private java.lang.String`	`readText(int length)` Read one blink structure
`java.lang.String`	`ReadTextMsg()` Read text message @throws IOException
`short`	`ReadUnRegisterMsg()` Read unregister message @throws IOException
`void`	`WriteBlinksMsg(Queue<GazeEntryBase> bQue)` Write blinks message
`private void`	`WriteClientHeaderMsg(int msgType, int destinationId, int length)` Write outcome message, describing the data that will follow it
`void`	`WriteDescriptionMsg(java.lang.String description)` Write description message
`void`	`WriteFixationsMsg(Queue<GazeEntryBase> fQue)` Write fixations message
`private void`	`writeGazeEntry(GazeEntryBase entry)`
`protected void`	`WriteGazeEntryMsg(Queue<GazeEntryBase> entries, int msgType, int entrySize, int dstId)`
`private void`	`writeHeaderMsg(int type, int subtype, int destinationId, int length)` C2S messages processing.
`void`	`WriteNameMsg(java.lang.String name)` Write name message
`void`	`WritePokeMsg()` Write poke message
`void`	`WriteRegisterMsg()` Write register message
`void`	`WriteSamplesMsg(Queue<GazeEntryBase> sQue)` Write single samples message
`private void`	`writeText(java.lang.String str)` Write text
`void`	`WriteTextMsg(java.lang.String text)` Write text message
`void`	`WriteUnregisterMsg()` Write unregister message

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVER_ID
```
static final int SERVER_ID
```
    Message destination Id. Server is a destination, not for further distribution
    
    See Also:
    Constant Field Values
  - ANY_ID
```
static final int ANY_ID
```
    Message destination Id. All clients are marked as destination
    
    See Also:
    Constant Field Values
  - gdGazeMsg
```
public static final int gdGazeMsg
```
    Message types
    
    See Also:
    Constant Field Values
  - gdControlMsg
```
public static final int gdControlMsg
```
    Message types
    
    See Also:
    Constant Field Values
  - gdTextMsg
```
public static final int gdTextMsg
```
    Message types
    
    See Also:
    Constant Field Values
  - gdGazeSample
```
public static final int gdGazeSample
```
    gdGazeMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdGazeFixation
```
public static final int gdGazeFixation
```
    gdGazeMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdGazeBlink
```
public static final int gdGazeBlink
```
    gdGazeMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdPoke
```
public static final int gdPoke
```
    gdControlMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdRegister
```
public static final int gdRegister
```
    gdControlMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdUnregister
```
public static final int gdUnregister
```
    gdControlMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdName
```
public static final int gdName
```
    gdTextMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdDescription
```
public static final int gdDescription
```
    gdTextMsg Message subtypes
    
    See Also:
    Constant Field Values
  - gdText
```
public static final int gdText
```
    gdTextMsg Message subtypes
    
    See Also:
    Constant Field Values
  - srcClientId
```
public short srcClientId
```
    Last received image source
- Constructor Detail
  - GazeProto
```
GazeProto(java.lang.String h,
         int p,
         GazeVncViewer v)
    throws java.io.IOException
```
    Constructor
    
    Parameters:
    h - Host address
    p - Protocol
    v - Viewer
    
    Throws:
    
    java.io.IOException
- Method Detail
  - readServerMessageSubtype
```
public int readServerMessageSubtype()
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readHeaderMsg
```
private int readHeaderMsg()
                   throws java.io.IOException
```
    Read income server message, heading a list of gaze data structures type and subtype already read
    
    Returns:
    
    Throws:
    
    java.io.IOException
  - readSample
```
private GazeEntrySample readSample()
                            throws java.io.IOException
```
    Read one sample structure
    
    Returns:
    JGDSingleSample object
    
    Throws:
    
    java.io.IOException
  - readFixation
```
private GazeEntryFixation readFixation()
                                throws java.io.IOException
```
    Read one fixation structure
    
    Returns:
    JGDFixation object
    
    Throws:
    
    java.io.IOException
  - readBlink
```
private GazeEntryBlink readBlink()
                          throws java.io.IOException
```
    Read one blink structure
    
    Returns:
    JGDBlink object
    
    Throws:
    
    java.io.IOException
  - readText
```
private java.lang.String readText(int length)
                           throws java.io.IOException
```
    Read one blink structure
    
    Returns:
    JGDBlink object
    
    Throws:
    
    java.io.IOException
  - ReadSamplesMsg
```
public java.util.Vector<GazeEntrySample> ReadSamplesMsg()
                                                 throws java.io.IOException
```
    Read single samples message
    
    Returns:
    Vector of JGDSingleSample structures, received from the server
    
    Throws:
    
    java.io.IOException
  - ReadFixationsMsg
```
public java.util.Vector<GazeEntryFixation> ReadFixationsMsg()
                                                     throws java.io.IOException
```
    Read fixations message
    
    Returns:
    Vector of JGDFixation structures, received from the server
    
    Throws:
    
    java.io.IOException
  - ReadBlinksMsg
```
public java.util.Vector<GazeEntryBlink> ReadBlinksMsg()
                                               throws java.io.IOException
```
    Read blinks message
    
    Returns:
    Vector of JGDBlink structures, received from the server
    
    Throws:
    
    java.io.IOException
  - ReadRegisterMsg
```
public short ReadRegisterMsg()
                      throws java.io.IOException
```
    Read register message @throws IOException
    
    Throws:
    
    java.io.IOException
  - ReadUnRegisterMsg
```
public short ReadUnRegisterMsg()
                        throws java.io.IOException
```
    Read unregister message @throws IOException
    
    Throws:
    
    java.io.IOException
  - ReadPokeMsg
```
public short ReadPokeMsg()
                  throws java.io.IOException
```
    Read register message @throws IOException
    
    Throws:
    
    java.io.IOException
  - ReadNameMsg
```
public java.lang.String ReadNameMsg()
                             throws java.io.IOException
```
    Read name message @throws IOException
    
    Throws:
    
    java.io.IOException
  - ReadDescriptionMsg
```
public java.lang.String ReadDescriptionMsg()
                                    throws java.io.IOException
```
    Read description message @throws IOException
    
    Throws:
    
    java.io.IOException
  - ReadTextMsg
```
public java.lang.String ReadTextMsg()
                             throws java.io.IOException
```
    Read text message @throws IOException
    
    Throws:
    
    java.io.IOException
  - writeHeaderMsg
```
private void writeHeaderMsg(int type,
                  int subtype,
                  int destinationId,
                  int length)
                     throws java.io.IOException
```
    C2S messages processing. Writing messages to the stream
    
    Throws:
    
    java.io.IOException
  - WriteClientHeaderMsg
```
private void WriteClientHeaderMsg(int msgType,
                        int destinationId,
                        int length)
                           throws java.io.IOException
```
    Write outcome message, describing the data that will follow it
    
    Throws:
    
    java.io.IOException
  - writeGazeEntry
```
private void writeGazeEntry(GazeEntryBase entry)
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeText
```
private void writeText(java.lang.String str)
                throws java.io.IOException
```
    Write text
    
    Throws:
    
    java.io.IOException
  - WriteSamplesMsg
```
public void WriteSamplesMsg(Queue<GazeEntryBase> sQue)
                     throws java.io.IOException
```
    Write single samples message
    
    Parameters:
    ssVec - Queue of JGDSingleSample structures, received from the server
    
    Throws:
    
    java.io.IOException
  - WriteGazeEntryMsg
```
protected void WriteGazeEntryMsg(Queue<GazeEntryBase> entries,
                     int msgType,
                     int entrySize,
                     int dstId)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - WriteFixationsMsg
```
public void WriteFixationsMsg(Queue<GazeEntryBase> fQue)
                       throws java.io.IOException
```
    Write fixations message
    
    Parameters:
    fVec - Queue of JGDFixation structures, received from the server
    
    Throws:
    
    java.io.IOException
  - WriteBlinksMsg
```
public void WriteBlinksMsg(Queue<GazeEntryBase> bQue)
                    throws java.io.IOException
```
    Write blinks message
    
    Parameters:
    bVec - Queue of JGDBlink structures, received from the server
    
    Throws:
    
    java.io.IOException
  - WriteNameMsg
```
public void WriteNameMsg(java.lang.String name)
                  throws java.io.IOException
```
    Write name message
    
    Parameters:
    name - New name of the client that should be sent to the server and distributed to clients
    
    Throws:
    
    java.io.IOException
  - WriteDescriptionMsg
```
public void WriteDescriptionMsg(java.lang.String description)
                         throws java.io.IOException
```
    Write description message
    
    Parameters:
    description - New description of the client that should be sent to the server and distributed to clients
    
    Throws:
    
    java.io.IOException
  - WriteTextMsg
```
public void WriteTextMsg(java.lang.String text)
                  throws java.io.IOException
```
    Write text message
    
    Parameters:
    text - New text message that should be sent to the server and distributed to clients
    
    Throws:
    
    java.io.IOException
  - WriteRegisterMsg
```
public void WriteRegisterMsg()
                      throws java.io.IOException
```
    Write register message
    
    Throws:
    
    java.io.IOException
  - WriteUnregisterMsg
```
public void WriteUnregisterMsg()
                        throws java.io.IOException
```
    Write unregister message
    
    Throws:
    
    java.io.IOException
  - WritePokeMsg
```
public void WritePokeMsg()
                  throws java.io.IOException
```
    Write poke message
    
    Throws:
    
    java.io.IOException

Class GazeProto

Field Summary

Fields inherited from class TightVnc.RfbProto

Constructor Summary

Method Summary

Methods inherited from class TightVnc.RfbProto

Methods inherited from class java.lang.Object

Field Detail

SERVER_ID

ANY_ID

gdGazeMsg

gdControlMsg

gdTextMsg

gdGazeSample

gdGazeFixation

gdGazeBlink

gdPoke

gdRegister

gdUnregister

gdName

gdDescription

gdText

srcClientId

Constructor Detail

GazeProto

Method Detail

readServerMessageSubtype

readHeaderMsg

readSample

readFixation

readBlink

readText

ReadSamplesMsg

ReadFixationsMsg

ReadBlinksMsg

ReadRegisterMsg

ReadUnRegisterMsg

ReadPokeMsg

ReadNameMsg

ReadDescriptionMsg

ReadTextMsg

writeHeaderMsg

WriteClientHeaderMsg

writeGazeEntry

writeText

WriteSamplesMsg

WriteGazeEntryMsg

WriteFixationsMsg

WriteBlinksMsg

WriteNameMsg

WriteDescriptionMsg

WriteTextMsg

WriteRegisterMsg

WriteUnregisterMsg

WritePokeMsg