org.a11y.brlapi

Class ConnectionBase

java.lang.Object

org.a11y.brlapi.Component

org.a11y.brlapi.NativeComponent

org.a11y.brlapi.ConnectionBase

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

Connection

public class ConnectionBase
extends NativeComponent
implements java.lang.AutoCloseable

Field Summary

Fields inherited from class org.a11y.brlapi.Component

BYTE_MASK, UNICODE_BRAILLE_ROW

Constructor Summary

Constructors

Constructor and Description
ConnectionBase(ConnectionSettings settings)

Method Summary

Modifier and Type	Method and Description
void	acceptAllKeys()
void	acceptKeyRanges(long[][] ranges)
void	acceptKeys(long type, long[] keys)
void	close()
void	enterRawMode(java.lang.String driver)
int	enterTtyMode(int tty, java.lang.String driver)
void	enterTtyModeWithPath(java.lang.String driver, int... ttys)
java.lang.String	getAuthenticationScheme()
static ConnectionBase	getConnection(long handle)
DisplaySize	getDisplaySize()
java.lang.String	getDriverName()
int	getFileDescriptor()
java.lang.String	getModelIdentifier()
java.lang.Object	getParameter(int parameter, long subparam, boolean global)
java.lang.String	getServerHost()
void	ignoreAllKeys()
void	ignoreKeyRanges(long[][] ranges)
void	ignoreKeys(long type, long[] keys)
boolean	isUnusable()
void	leaveRawMode()
void	leaveTtyMode()
void	pause(int milliseconds)
java.lang.Long	readKey(boolean wait)
long	readKeyWithTimeout(int milliseconds)
int	recvRaw(byte[] buffer)
int	sendRaw(byte[] buffer)
void	setFocus(int tty)
void	setParameter(int parameter, long subparam, boolean global, java.lang.Object value)
static void	setUnusable(long handle)
static void	unwatchParameter(long identifier)
long	watchParameter(int parameter, long subparam, boolean global, ParameterWatcher watcher)
void	write(WriteArguments arguments)
protected void	writeDots(byte[] dots)
protected void	writeText(int cursor, java.lang.String text)

Methods inherited from class org.a11y.brlapi.Component

getObjectName, getObjectName, printf, toOperandName, toUnicodeBraille, toUnicodeBraille

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionBase

public ConnectionBase(ConnectionSettings settings)
               throws ConnectException

Throws:

ConnectException

Method Detail

getServerHost

public final java.lang.String getServerHost()

getAuthenticationScheme

public final java.lang.String getAuthenticationScheme()

getFileDescriptor

public final int getFileDescriptor()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getConnection

public static ConnectionBase getConnection(long handle)

setUnusable

public static void setUnusable(long handle)

isUnusable

public final boolean isUnusable()

getDriverName

public java.lang.String getDriverName()

getModelIdentifier

public java.lang.String getModelIdentifier()

getDisplaySize

public DisplaySize getDisplaySize()

pause

public void pause(int milliseconds)
           throws java.io.InterruptedIOException

Throws:

java.io.InterruptedIOException

enterTtyMode

public int enterTtyMode(int tty,
                        java.lang.String driver)

enterTtyModeWithPath

public void enterTtyModeWithPath(java.lang.String driver,
                                 int... ttys)

leaveTtyMode

public void leaveTtyMode()

setFocus

public void setFocus(int tty)

writeText

protected void writeText(int cursor,
                         java.lang.String text)

writeDots

protected void writeDots(byte[] dots)

write

public void write(WriteArguments arguments)

readKey

public java.lang.Long readKey(boolean wait)
                       throws java.io.InterruptedIOException

Throws:

java.io.InterruptedIOException

readKeyWithTimeout

public long readKeyWithTimeout(int milliseconds)
                        throws java.io.InterruptedIOException,
                               java.util.concurrent.TimeoutException

Throws:

java.io.InterruptedIOException

java.util.concurrent.TimeoutException

ignoreKeys

public void ignoreKeys(long type,
                       long[] keys)

acceptKeys

public void acceptKeys(long type,
                       long[] keys)

ignoreAllKeys

public void ignoreAllKeys()

acceptAllKeys

public void acceptAllKeys()

ignoreKeyRanges

public void ignoreKeyRanges(long[][] ranges)

acceptKeyRanges

public void acceptKeyRanges(long[][] ranges)

enterRawMode

public void enterRawMode(java.lang.String driver)

leaveRawMode

public void leaveRawMode()

sendRaw

public int sendRaw(byte[] buffer)

recvRaw

public int recvRaw(byte[] buffer)
            throws java.io.InterruptedIOException

Throws:

java.io.InterruptedIOException

getParameter

public java.lang.Object getParameter(int parameter,
                                     long subparam,
                                     boolean global)

setParameter

public void setParameter(int parameter,
                         long subparam,
                         boolean global,
                         java.lang.Object value)

watchParameter

public long watchParameter(int parameter,
                           long subparam,
                           boolean global,
                           ParameterWatcher watcher)

unwatchParameter

public static void unwatchParameter(long identifier)