Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accept - Static variable in class com.quanser.communications.QuanserStream.PollFlag
-
Not valid on a client stream.
- accept() - Method in class com.quanser.communications.QuanserStream
-
Accepts a connection to a listening communication stream by a client and uses default send and receive buffer sizes.
- accept(int, int) - Method in class com.quanser.communications.QuanserStream
-
Accepts a connection to a listening communication stream by a client.
- auto - Enum constant in enum com.quanser.communications.QuanserStream.CharacterFormat
-
Determine character format automatically (requires BOM for UTF-16 and UTF-32)
B
- bigEndian - Enum constant in enum com.quanser.communications.QuanserStream.ByteOrder
-
Big endian (Motorola) byte order
C
- close() - Method in class com.quanser.communications.QuanserStream
-
Closes the stream.
- closeAll() - Method in class com.quanser.communications.QuanserStream
-
Closes all streams currently connected or listening.
- com.quanser.communications - package com.quanser.communications
-
Provides the classes necessary to use the Quanser Communications API.
- connect - Static variable in class com.quanser.communications.QuanserStream.PollFlag
-
Not valid on a listening stream.
- connect(String) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking I/O and default send and receive buffer sizes.
- connect(String, boolean) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking or non-blocking I/O and default send and receive buffer sizes.
- connect(String, boolean, int, int) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking or non-blocking I/O.
- connect(String, int, int) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking I/O.
- connect(URI) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking I/O and default send and receive buffer sizes.
- connect(URI, boolean) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking or non-blocking I/O and default send and receive buffer sizes.
- connect(URI, boolean, int, int) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking or non-blocking I/O.
- connect(URI, int, int) - Method in class com.quanser.communications.QuanserStream
-
Connects to a server listening on the given URI using blocking I/O.
F
- flush - Static variable in class com.quanser.communications.QuanserStream.PollFlag
-
Not valid on a listening stream.
- flush() - Method in class com.quanser.communications.QuanserStream
-
Flushes the stream send buffer to the underlying communication channel.
G
- getCharacterFormat() - Method in class com.quanser.communications.QuanserStream
-
Returns the character format of the stream.
- getInputStream() - Method in class com.quanser.communications.QuanserStream
-
Returns an
InputStream
object for thisQuanserStream
. - getOutputStream() - Method in class com.quanser.communications.QuanserStream
-
Returns an
OutputStream
object for thisQuanserStream
.
I
- ignore(int) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of bytes from the stream and discards them.
L
- listen(String) - Method in class com.quanser.communications.QuanserStream
-
Establishes a listening server stream which listens on the given URI using blocking I/O.
- listen(String, boolean) - Method in class com.quanser.communications.QuanserStream
-
Establishes a listening server stream which listens on the given URI using blocking or non-blocking I/O.
- listen(URI) - Method in class com.quanser.communications.QuanserStream
-
Establishes a listening server stream which listens on the given URI using blocking I/O.
- listen(URI, boolean) - Method in class com.quanser.communications.QuanserStream
-
Establishes a listening server stream which listens on the given URI using blocking or non-blocking I/O.
- littleEndian - Enum constant in enum com.quanser.communications.QuanserStream.ByteOrder
-
Little endian (Intel) byte order
N
- nativeEndian - Enum constant in enum com.quanser.communications.QuanserStream.ByteOrder
-
Native byte order
P
- poll(double, int) - Method in class com.quanser.communications.QuanserStream
-
Polls the stream for events, such as whether it is possible to send or receive without blocking.
- PollFlag() - Constructor for class com.quanser.communications.QuanserStream.PollFlag
Q
- QCOMM_POLL_ACCEPT - Static variable in class com.quanser.communications.QuanserCommunications
-
Flag used by the qcomm_poll native function.
- QCOMM_POLL_CONNECT - Static variable in class com.quanser.communications.QuanserCommunications
-
Flag used by the qcomm_poll native function.
- QCOMM_POLL_RECEIVE - Static variable in class com.quanser.communications.QuanserCommunications
-
Flag used by the qcomm_poll native function.
- QCOMM_POLL_SEND - Static variable in class com.quanser.communications.QuanserCommunications
-
Flag used by the qcomm_poll native function.
- QuanserCommunications - Class in com.quanser.communications
-
The Quanser Communications API.
- QuanserCommunications() - Constructor for class com.quanser.communications.QuanserCommunications
-
Constructs an unconnected
QuanserCommunications
object. - QuanserStream - Class in com.quanser.communications
-
The Quanser Stream API is a generic buffered communication protocol API based upon the Quanser Communications API.
- QuanserStream() - Constructor for class com.quanser.communications.QuanserStream
-
Constructs a
QuanserStream
object. - QuanserStream.ByteOrder - Enum in com.quanser.communications
-
Enumerates the different byte orders.
- QuanserStream.CharacterFormat - Enum in com.quanser.communications
-
Enumerates the different character formats available for textual communications.
- QuanserStream.PollFlag - Class in com.quanser.communications
-
Defines the flags used by the
poll
method.
R
- receive - Static variable in class com.quanser.communications.QuanserStream.PollFlag
-
On a listening stream, check for connections pending from clients.
- receive(byte[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 8-bit integers (i.e., bytes) from the stream.
- receive(double[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 64-bit, double-precision, floating-point numbers (i.e., doubles) from the stream.
- receive(float[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 32-bit, single-precision, floating-point numbers (i.e., floats) from the stream.
- receive(int[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 32-bit integers (i.e., ints) from the stream.
- receive(long[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 64-bit integers (i.e., longs) from the stream.
- receive(short[]) - Method in class com.quanser.communications.QuanserStream
-
Reads the specified number of 16-bit integers (i.e., shorts) from the stream.
- receiveArray(byte[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 8-bit integers (i.e., bytes) from the stream.
- receiveArray(double[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 64-bit, double-precision, floating-point numbers (i.e., doubles) from the stream.
- receiveArray(float[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 32-bit, single-precision, floating-point numbers (i.e., floats) from the stream.
- receiveArray(int[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 32-bit integers (i.e., ints) from the stream.
- receiveArray(long[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 64-bit integers (i.e., longs) from the stream.
- receiveArray(short[]) - Method in class com.quanser.communications.QuanserStream
-
Reads an array of 16-bit integers (i.e., shorts) from the stream.
S
- send - Static variable in class com.quanser.communications.QuanserStream.PollFlag
-
Not valid on a listening stream.
- send(byte[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 8-bit integers (i.e., bytes) to the stream send buffer.
- send(double[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 64-bit, double-precision, floating-point (i.e., doubles) to the stream send buffer.
- send(float[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 32-bit, single-precision, floating-point (i.e., floats) to the stream send buffer.
- send(int[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 32-bit integers (i.e., ints) to the stream send buffer.
- send(long[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 64-bit integers (i.e., longs) to the stream send buffer.
- send(short[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified number of 16-bit integers (i.e., shorts) to the stream send buffer.
- sendArray(byte[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 8-bit integers (i.e., bytes) to the stream send buffer.
- sendArray(double[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 64-bit, double-precision, floating-point numbers (i.e., doubles) to the stream send buffer.
- sendArray(float[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 32-bit, single-precision, floating-point numbers (i.e., floats) to the stream send buffer.
- sendArray(int[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 32-bit integers (i.e., ints) to the stream send buffer.
- sendArray(long[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 64-bit integers (i.e., longs) to the stream send buffer.
- sendArray(short[]) - Method in class com.quanser.communications.QuanserStream
-
Writes the specified array of 16-bit integers (i.e., shorts) to the stream send buffer.
- sendByte(byte) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 8-bit integer (i.e., byte) to the stream send buffer.
- sendDouble(double) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 64-bit, double-precision, floating-point (i.e., double) to the stream send buffer.
- sendFloat(float) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 32-bit, single-precision, floating-point (i.e., float) to the stream send buffer.
- sendInt(int) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 32-bit integer (i.e., int) to the stream send buffer.
- sendLong(long) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 64-bit integer (i.e., long) to the stream send buffer.
- sendShort(short) - Method in class com.quanser.communications.QuanserStream
-
Writes a single 16-bit integer (i.e., short) to the stream send buffer.
- setByteOrder(QuanserStream.ByteOrder) - Method in class com.quanser.communications.QuanserStream
-
Configures the byte order used by methods that send and receive various data types, or arrays of types.
- setCharacterFormat(QuanserStream.CharacterFormat) - Method in class com.quanser.communications.QuanserStream
-
Configures whether the methods that send and receive characters convert between the local character format and another character format when reading and writing to the underlying communication channel.
- setSwapBytes(boolean) - Method in class com.quanser.communications.QuanserStream
-
Configures whether the methods that send and receive various data types, or arrays of types, swap the bytes in the individual values in order to account for endian differences between the client and server.
- shutdown() - Method in class com.quanser.communications.QuanserStream
-
Shuts down send and/or receive operations in preparation for closing the stream.
U
- utf16 - Enum constant in enum com.quanser.communications.QuanserStream.CharacterFormat
-
UTF-16 characters (two byte code unit, up to 2 code units per character)
- utf32 - Enum constant in enum com.quanser.communications.QuanserStream.CharacterFormat
-
UTF-32 characters (four byte code unit, always one code unit per character)
- utf8 - Enum constant in enum com.quanser.communications.QuanserStream.CharacterFormat
-
UTF-8 characters (one byte code unit, up to 4 code units per character)
V
- valueOf(String) - Static method in enum com.quanser.communications.QuanserStream.ByteOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.quanser.communications.QuanserStream.CharacterFormat
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.quanser.communications.QuanserStream.ByteOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.quanser.communications.QuanserStream.CharacterFormat
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values