com.ibm.rational.test.lt.tn3270.execution.custom

Interface ITn3270ConnectionHolder

All Superinterfaces:

com.ibm.rational.test.lt.execution.socket.custom.ISckConnectionHolder

public interface ITn3270ConnectionHolder
extends com.ibm.rational.test.lt.execution.socket.custom.ISckConnectionHolder

ITn3270ConnectionHolder is the interface to the underlying Tn3270 connection.

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumns()
String	getDeviceBuffer() This method allocates a new java.lang.String instance as large as the device buffer
String	getDeviceBuffer(int line, int column, int length) Extract a subPortion of the device buffer content
char[]	getDeviceBufferAsCharArray() Deprecated. use int[] getDeviceBufferAsCodePointArray() instead
int[]	getDeviceBufferAsCodePointArray() This method directly returns the underlying int array that contains the device buffer
String	getRequestedLUName()
int	getRows()
void	setRequestedLUName(String newLUName) Change the requested Logical Unit name to connect to the remote peer.

Methods inherited from interface com.ibm.rational.test.lt.execution.socket.custom.ISckConnectionHolder

getCurrentlyReceivedBytes, getCurrentlyReceivedBytesCount, getFinallyReceivedBytes, getFinallyReceivedBytesCount, getHostName, getLastConnectOrSendTimeStamp, getLastSentBytes, getLastSentBytesCount, getPort, getResponseTime, isConnected, isEndOfStream, rewind, setHostName, setPort, setResponseTime

Method Detail

getRequestedLUName

String getRequestedLUName()

Returns:

the requested Logical Unit name to connect to the remote peer, or null if none requested.

setRequestedLUName

void setRequestedLUName(String newLUName)

Change the requested Logical Unit name to connect to the remote peer.
Calling this method after the connection is established and that the negotiation has started has no effect.

Parameters:

newLUName - the new value to be used for this connection

getRows

int getRows()

Returns:

the number of lines of the device buffer

getColumns

int getColumns()

Returns:

the number of columns in a line of the device buffer

getDeviceBuffer

String getDeviceBuffer()

This method allocates a new java.lang.String instance as large as the device buffer

Returns:

the full current content of the device buffer as a Unicode java.lang.String

getDeviceBufferAsCharArray

char[] getDeviceBufferAsCharArray()

Deprecated. use int[] getDeviceBufferAsCodePointArray() instead

Returns:

something that was buggy as it cannot handle high surrogate chars

getDeviceBufferAsCodePointArray

int[] getDeviceBufferAsCodePointArray()

This method directly returns the underlying int array that contains the device buffer

Returns:

the full current content of the device buffer as a Unicode code point array

getDeviceBuffer

String getDeviceBuffer(int line,
                     int column,
                     int length)

Extract a subPortion of the device buffer content

Parameters:

line - in the range 1 through getRows()

column - in the range 1 through getColumns()

length - the number of device buffer locations to extract

Returns:

the current content of the device buffer at this location and as a Unicode java.lang.String