RWTnAction (FreeHost3270 modules suite 0.2-CURRENT API)

All Known Implementing Classes:

DefaultTerminalModel, JTerminalScreen
```
public interface RWTnAction
```
Provides a callback to consumers from the RWTelnet object. When developing a 3270 client using the RightHost APIs, you must implement this interface and pass it to the RW3270 Object when it's instantiated. It provides several important methods that the 3270 engine calls to inform the implementation of 3270 events.

See Also:
RW3270

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONNECTION_ERROR` Status constant passed to `status()` indicating that there was a problem connecting to the 3270 host or SessionServer
`static int`	`DISCONNECTED_BY_REMOTE_HOST` Status constant passed to `status()` indicating that the client's connection to the host has been closed.
`static int`	`READY` Status constant passed to `status()` indicating that the 3270 engine is ready for user input
`static int`	`X_WAIT` Status constant passed to `status()` indicating that the 3270 engine is waiting for a response from the 3270 host.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beep()` This method is called when the host application sends the beep command.
`void`	`broadcastMessage(String msg)` This method is called when the SessionServer admin sends a broadcast message to all currently connected clients.
`void`	`cursorMove(int oldPos, int newPos)` This method is called when the cursor position (current buffer position) of the 3270 engine is changed by host commands or by user input.
`void`	`incomingData()` Is called by the 3270 telnet engine when it has received new data.
`void`	`status(int msg)` This method is called by the 3270 engine to communicate status changes to the client.

- Field Detail
  - DISCONNECTED_BY_REMOTE_HOST
```
static final int DISCONNECTED_BY_REMOTE_HOST
```
    Status constant passed to status() indicating that the client's connection to the host has been closed.
    
    See Also:
    Constant Field Values
  - CONNECTION_ERROR
```
static final int CONNECTION_ERROR
```
    Status constant passed to status() indicating that there was a problem connecting to the 3270 host or SessionServer
    
    See Also:
    Constant Field Values
  - X_WAIT
```
static final int X_WAIT
```
    Status constant passed to status() indicating that the 3270 engine is waiting for a response from the 3270 host.
    
    See Also:
    Constant Field Values
  - READY
```
static final int READY
```
    Status constant passed to status() indicating that the 3270 engine is ready for user input
    
    See Also:
    Constant Field Values
- Method Detail
  - beep
```
void beep()
```
    This method is called when the host application sends the beep command. It should fire some sort of audible alarm on the client's system. For example:
```
 public void beep() {
    Toolkit.getDefaultToolkit().beep();
 }
 
```
  - broadcastMessage
```
void broadcastMessage(String msg)
```
    This method is called when the SessionServer admin sends a broadcast message to all currently connected clients.
    If you're implementing Broadcast Messaging in your client, this method should paint String msg to the client's screen.
    
    Parameters:
    msg - The broadcast message from the system administrator.
  - cursorMove
```
void cursorMove(int oldPos,
              int newPos)
```
    This method is called when the cursor position (current buffer position) of the 3270 engine is changed by host commands or by user input. When drawing the cursor to the client's display, use this method to fire cursor draw logic.
    This is useful for 'undrawing' the cursor before drawing it in its new position. The position is returned as an integer value between 0 (first character position) and len(dataBuffer) - 1 (last character position). For example using 3270 Model 2. The value would be between 0 and 1919.
    
    Parameters:
    oldPos - The previous cursor position.
    newPos - The new (current) cursor position.
  - incomingData
```
void incomingData()
```
    Is called by the 3270 telnet engine when it has received new data.
    This method would usually call a paint() method or other display update. Note: this method is useful when the client implementation is stateful. If the 3270 engine does not have direct access to the user's display, the RW3270.waitForNewData() method will suspend the calling thread until new data arrives.
  - status
```
void status(int msg)
```
    This method is called by the 3270 engine to communicate status changes to the client. The possible values for int are outlined in the constants for this field.
    - RWtnAction.DISCONNECTED_BY_REMOTE_HOST: This status message indicates that the connection to the host was lost.
    - RWTnAction.CONNECTION_ERROR: This status message that there was a problem connecting to the SessionServer or that the SessionServer had trouble connecting to the 3270 host.
    - RWTnAction.X_WAIT: This status message means the 3270 engine is waiting for a response from the 3270 host.
    - RWTnAction.READY: This status message means the 3270 engine is ready for input from the client implementation.
    Parameters:
    msg - The status message

Interface RWTnAction

Field Summary

Method Summary

Field Detail

DISCONNECTED_BY_REMOTE_HOST

CONNECTION_ERROR

X_WAIT

READY

Method Detail

beep

broadcastMessage

cursorMove

incomingData

status