HostSessionPeer (NetPhantom® 7.7 Java API Specification)

All Known Implementing Classes:

HostSession3270, HostSession3270Printer, HostSession5250, HostSessionEE
```
public interface HostSessionPeer
```
The interface for 3270 or 5250 host sessions.
It is also a collection of host session states.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`STATE_CommunicationCheck` 3270: X-COMM.
`static long`	`STATE_CommunicationsError` 3270: lightning bolt.
`static long`	`STATE_Error` General error flag.
`static long`	`STATE_FieldFullError` 3270: X-stickman>
`static long`	`STATE_InsertMode` General insert mode flag.
`static long`	`STATE_KeyboardShift` 5250: KS (not implemented).
`static long`	`STATE_Lock` General lock flag.
`static long`	`STATE_LULUOwned` 3270: 4B#.
`static long`	`STATE_MachineCheck` 3270: X-MACH.
`static long`	`STATE_MessageWaiting` 5250: MW.
`static long`	`STATE_MinusError` 3270: X-f.
`static long`	`STATE_MinusErrorXfStickman` 3270: X-f stickman.
`static long`	`STATE_NonNumericError` 3270.
`static long`	`STATE_OnFieldOrProtected` 3270.
`static long`	`STATE_OnlineNotOwned` 3270: 4B?.
`static long`	`STATE_ProgramCheck` 3270: X-PROG.
`static long`	`STATE_ReceiveWait` Waiting for data.
`static long`	`STATE_Secure` Secured with SSL communication.
`static long`	`STATE_Sending` Sending data pending.
`static long`	`STATE_SSCPLUOwned` 3270: 4Bstickman.
`static long`	`STATE_SystemAvailable` General system availability.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`connect()` Connects the session to host.
`boolean`	`disconnect()` Disconnects the session from host.
`void`	`displayHiddenText(boolean display)` Informs the session that hidden text should be displayed as bright red on black background.
`boolean`	`doesFieldHaveExtendedAttributes(HostField hostField)` Checks if a host field has extended attributes or not.
`boolean`	`doesHostNeedFieldExit(int x, int y, int offset, int length, String string)` For 5250: checks if a field has the attributes that requires this particular string to enter the data followed by a "Field Exit" or "Field Minus" key.
`String`	`getAllowedCharacters()` Gets the string of characters that can be input by the user using the configured host code page for this session.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos)` Gets the characters and attributes between two positions, including the end position.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos, char fieldOrNullChar)` Gets the characters and attributes between two positions, including the end position.
`int`	`getClientHostFieldFlags(HostField hostField)` Gets flags that are required for the client host fields for local editing, etc.
`Point`	`getCursor()` Gets the current host cursor position.
`String`	`getDeviceName()` Gets the device name of the session.
`int`	`getHomeAddress()` Gets the host address index on the screen.
`HostSessionListener2`	`getHostSessionListener()` Gets the host session listener.
`String`	`getLastError(boolean doClear)` Gets the last error message of the session.
`int`	`getNewCharAttribute(HostField hostField)` Gets the attribute to use for new characters in a field that contains extended attributes (always zero for non-3270).
`int`	`getScreenLength()` Gets the current screen length (width * height).
`Dimension`	`getScreenSize()` Gets the current screen size.
`long`	`getSessionState()` Gets the current session state.
`void`	`initiate(HostSessionListener listener, String address, int port, String peerData)` Deprecated. As of version 3.8, use method using HostSessionListener2.
`void`	`initiate2(HostSessionListener2 listener, String address, int port, String peerData)` Initiates an instance of the host session, but does not connect to the host.
`boolean`	`is3270()` Checks if a session is 3270 or 5250.
`boolean`	`isAutoReconnectSessionEnabled()` Checks if the use of auto reconnect session is handled or not.
`boolean`	`isFieldFormatted()` Checks if this host screen is field formatted.
`boolean`	`isHiddenTextDisplayed()` Checks if hidden text is displayed.
`boolean`	`isPrinter()` Checks if this is a printer or not.
`boolean`	`isProcessingDataStream()` Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.
`void`	`refreshHostFields(HostFields fields)` Refreshes the host fields of the current session.
`boolean`	`sendCharacterString(String keys)` Sends character keystrokes to host.
`boolean`	`sendKey(int key)` Sends keystrokes to host.
`boolean`	`setCursor(int x, int y)` Sets the host cursor position.
`boolean`	`setHostField(HostField hostField, String data, int[] attrs)` Sets a host field fully with text data and perhaps attributes (if these are non-null).
`boolean`	`setHostString(int x, int y, int offset, int length, String string)` Sets a string to a host field.
`boolean`	`setHostStringAsKeys(int x, int y, int offset, int length, String string)` Sets a string to a host field just as if the user typed the characters.
`boolean`	`setInsertMode(boolean on)` Sets the insert mode.
`void`	`setLastError(String errMsg)` Sets the last error message of the session.

- Field Detail
  - STATE_Lock
```
static final long STATE_Lock
```
    General lock flag.
    
    See Also:
    
    Constant Field Values
  - STATE_Error
```
static final long STATE_Error
```
    General error flag.
    
    See Also:
    
    Constant Field Values
  - STATE_SystemAvailable
```
static final long STATE_SystemAvailable
```
    General system availability.
    
    See Also:
    
    Constant Field Values
  - STATE_InsertMode
```
static final long STATE_InsertMode
```
    General insert mode flag.
    
    See Also:
    
    Constant Field Values
  - STATE_Sending
```
static final long STATE_Sending
```
    Sending data pending.
    
    See Also:
    
    Constant Field Values
  - STATE_ReceiveWait
```
static final long STATE_ReceiveWait
```
    Waiting for data.
    
    See Also:
    
    Constant Field Values
  - STATE_Secure
```
static final long STATE_Secure
```
    Secured with SSL communication.
    
    See Also:
    
    Constant Field Values
  - STATE_MessageWaiting
```
static final long STATE_MessageWaiting
```
    5250: MW.
    
    See Also:
    
    Constant Field Values
  - STATE_KeyboardShift
```
static final long STATE_KeyboardShift
```
    5250: KS (not implemented).
    
    See Also:
    
    Constant Field Values
  - STATE_OnlineNotOwned
```
static final long STATE_OnlineNotOwned
```
    3270: 4B?.
    
    See Also:
    
    Constant Field Values
  - STATE_LULUOwned
```
static final long STATE_LULUOwned
```
    3270: 4B#.
    
    See Also:
    
    Constant Field Values
  - STATE_SSCPLUOwned
```
static final long STATE_SSCPLUOwned
```
    3270: 4Bstickman.
    
    See Also:
    
    Constant Field Values
  - STATE_ProgramCheck
```
static final long STATE_ProgramCheck
```
    3270: X-PROG.
    
    See Also:
    
    Constant Field Values
  - STATE_CommunicationCheck
```
static final long STATE_CommunicationCheck
```
    3270: X-COMM.
    
    See Also:
    
    Constant Field Values
  - STATE_MachineCheck
```
static final long STATE_MachineCheck
```
    3270: X-MACH.
    
    See Also:
    
    Constant Field Values
  - STATE_FieldFullError
```
static final long STATE_FieldFullError
```
    3270: X-stickman>
    
    See Also:
    
    Constant Field Values
  - STATE_MinusError
```
static final long STATE_MinusError
```
    3270: X-f.
    
    See Also:
    
    Constant Field Values
  - STATE_OnFieldOrProtected
```
static final long STATE_OnFieldOrProtected
```
    3270.
    
    See Also:
    
    Constant Field Values
  - STATE_MinusErrorXfStickman
```
static final long STATE_MinusErrorXfStickman
```
    3270: X-f stickman.
    
    See Also:
    
    Constant Field Values
  - STATE_NonNumericError
```
static final long STATE_NonNumericError
```
    3270.
    
    See Also:
    
    Constant Field Values
  - STATE_CommunicationsError
```
static final long STATE_CommunicationsError
```
    3270: lightning bolt.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - initiate
```
@Deprecated
void initiate(HostSessionListener listener,
                           String address,
                           int port,
                           String peerData)
                    throws InternalError
```
    Deprecated. As of version 3.8, use method using HostSessionListener2.
    
    Initiates an instance of the host session, but does not connect to the host.
    
    Throws:
    
    InternalError - Always with message "Deprecated and unsupported method".
    
    See Also:
    
    initiate2(HostSessionListener2, String, int, String)
  - initiate2
```
void initiate2(HostSessionListener2 listener,
               String address,
               int port,
               String peerData)
        throws IOException
```
    Initiates an instance of the host session, but does not connect to the host.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - connect
```
boolean connect()
```
    Connects the session to host.
  - disconnect
```
boolean disconnect()
```
    Disconnects the session from host.
  - getScreenSize
```
Dimension getScreenSize()
```
    Gets the current screen size.
  - getScreenLength
```
int getScreenLength()
```
    Gets the current screen length (width * height).
  - sendCharacterString
```
boolean sendCharacterString(String keys)
```
    Sends character keystrokes to host.
  - sendKey
```
boolean sendKey(int key)
```
    Sends keystrokes to host.
    
    See Also:
    
    HostSendKeys
  - setHostString
```
boolean setHostString(int x,
                      int y,
                      int offset,
                      int length,
                      String string)
```
    Sets a string to a host field.
  - setHostStringAsKeys
```
boolean setHostStringAsKeys(int x,
                            int y,
                            int offset,
                            int length,
                            String string)
```
    Sets a string to a host field just as if the user typed the characters. The host field is first cleared with (3270) Clear EOF or (5250) Field Exit or Field Minus (for negative numbers in a numeric field). The string is then entered as a set of keystrokes, followed by a potential Field Exit or Field Minus (for negative numbers in a numeric field), but only for 5250.
  - doesHostNeedFieldExit
```
boolean doesHostNeedFieldExit(int x,
                              int y,
                              int offset,
                              int length,
                              String string)
```
    For 5250: checks if a field has the attributes that requires this particular string to enter the data followed by a "Field Exit" or "Field Minus" key.
    
    Returns:
    
    false=field doesn't require field exit, true=field requires field exit.
  - setCursor
```
boolean setCursor(int x,
                  int y)
```
    Sets the host cursor position.
  - getCursor
```
Point getCursor()
```
    Gets the current host cursor position.
  - displayHiddenText
```
void displayHiddenText(boolean display)
```
    Informs the session that hidden text should be displayed as bright red on black background.
  - isHiddenTextDisplayed
```
boolean isHiddenTextDisplayed()
```
    Checks if hidden text is displayed.
  - getCharactersAndAttributes
```
void getCharactersAndAttributes(char[] chars,
                                int[] attrbs,
                                int beginPos,
                                int endPos)
```
    Gets the characters and attributes between two positions, including the end position.
  - getCharactersAndAttributes
```
void getCharactersAndAttributes(char[] chars,
                                int[] attrbs,
                                int beginPos,
                                int endPos,
                                char fieldOrNullChar)
```
    Gets the characters and attributes between two positions, including the end position. The character "fieldOrNullChar" is the character that will be used instead of field attributes and null characters.
  - getSessionState
```
long getSessionState()
```
    Gets the current session state.
  - refreshHostFields
```
void refreshHostFields(HostFields fields)
```
    Refreshes the host fields of the current session. The host session will add all available host fields sorted left to right, top to bottom.
  - is3270
```
boolean is3270()
```
    Checks if a session is 3270 or 5250.
    
    Returns:
    
    false if 5250,
    true if 3270.
  - isPrinter
```
boolean isPrinter()
```
    Checks if this is a printer or not.
  - getLastError
```
String getLastError(boolean doClear)
```
    Gets the last error message of the session.
    
    Returns:
    
    null if the session doesn't support it (3270 doesn't).
  - setLastError
```
void setLastError(String errMsg)
```
    Sets the last error message of the session.
  - getDeviceName
```
String getDeviceName()
```
    Gets the device name of the session.
    
    Returns:
    
    null if no device name exists.
  - isProcessingDataStream
```
boolean isProcessingDataStream()
```
    Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.
  - setInsertMode
```
boolean setInsertMode(boolean on)
```
    Sets the insert mode.
    
    Returns:
    
    true for success, false for failure.
  - doesFieldHaveExtendedAttributes
```
boolean doesFieldHaveExtendedAttributes(HostField hostField)
```
    Checks if a host field has extended attributes or not. 5250 never has, but 3270 could have, e.g. special highlighting.
  - getNewCharAttribute
```
int getNewCharAttribute(HostField hostField)
```
    Gets the attribute to use for new characters in a field that contains extended attributes (always zero for non-3270).
  - getClientHostFieldFlags
```
int getClientHostFieldFlags(HostField hostField)
```
    Gets flags that are required for the client host fields for local editing, etc.
  - getHostSessionListener
```
HostSessionListener2 getHostSessionListener()
```
    Gets the host session listener.
  - isAutoReconnectSessionEnabled
```
boolean isAutoReconnectSessionEnabled()
```
    Checks if the use of auto reconnect session is handled or not.
  - getHomeAddress
```
int getHomeAddress()
```
    Gets the host address index on the screen.
  - setHostField
```
boolean setHostField(HostField hostField,
                     String data,
                     int[] attrs)
```
    Sets a host field fully with text data and perhaps attributes (if these are non-null).
    
    Returns:
    
    true for success, false for failure.
  - getAllowedCharacters
```
String getAllowedCharacters()
```
    Gets the string of characters that can be input by the user using the configured host code page for this session.
    If the return string is empty, for the EE package for example, all characters are "inputable".
  - isFieldFormatted
```
boolean isFieldFormatted()
```
    Checks if this host screen is field formatted. This method is not like the one in HostScreen, this one checks directly to see if any fields are present.

Interface HostSessionPeer

Field Summary

Method Summary

Field Detail

STATE_Lock

STATE_Error

STATE_SystemAvailable

STATE_InsertMode

STATE_Sending

STATE_ReceiveWait

STATE_Secure

STATE_MessageWaiting

STATE_KeyboardShift

STATE_OnlineNotOwned

STATE_LULUOwned

STATE_SSCPLUOwned

STATE_ProgramCheck

STATE_CommunicationCheck

STATE_MachineCheck

STATE_FieldFullError

STATE_MinusError

STATE_OnFieldOrProtected

STATE_MinusErrorXfStickman

STATE_NonNumericError

STATE_CommunicationsError

Method Detail

initiate

initiate2

connect

disconnect

getScreenSize

getScreenLength

sendCharacterString

sendKey

setHostString

setHostStringAsKeys

doesHostNeedFieldExit

setCursor

getCursor

displayHiddenText

isHiddenTextDisplayed

getCharactersAndAttributes

getCharactersAndAttributes

getSessionState

refreshHostFields

is3270

isPrinter

getLastError

setLastError

getDeviceName

isProcessingDataStream

setInsertMode

doesFieldHaveExtendedAttributes

getNewCharAttribute

getClientHostFieldFlags

getHostSessionListener

isAutoReconnectSessionEnabled

getHomeAddress

setHostField

getAllowedCharacters

isFieldFormatted