Package org.acplt.oncrpc
Class XdrTcpEncodingStream
java.lang.Object
org.acplt.oncrpc.XdrEncodingStream
org.acplt.oncrpc.XdrTcpEncodingStream
The
XdrTcpEncodingStream
class provides the necessary
functionality to XdrEncodingStream
to send XDR records to the
network using the stream-oriented TCP/IP.- Version:
- $Revision: 1.2 $ $Date: 2003/08/14 11:07:39 $ $State: Exp $ $Locker: $
- Author:
- Harald Albrecht
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
The buffer which will be filled from the datagram socket and then be used to supply the information when decoding data.private int
Index of fragment header withinbuffer
.private int
Index of the last four byte word in thebuffer
.private int
The write pointer is an index into thebuffer
.private static final byte[]
Some zeros, only needed for padding -- like in real life.private Socket
The streaming socket to be used when receiving this XDR stream's buffer contents.(package private) OutputStream
The output stream used to get rid of bytes going off to the network. -
Constructor Summary
ConstructorsConstructorDescriptionXdrTcpEncodingStream
(Socket streamingSocket, int bufferSize) Construct a newXdrTcpEncodingStream
object and associate it with the givenstreamingSocket
for TCP/IP-based communication. -
Method Summary
Modifier and TypeMethodDescriptionvoid
beginEncoding
(InetAddress receiverAddress, int receiverPort) Begins encoding a new XDR record.void
close()
Closes this encoding XDR stream and releases any system resources associated with this stream.void
Flushes this encoding XDR stream and forces any buffered output bytes to be written out.void
endEncoding
(boolean flush) Ends the current record fort this encoding XDR stream.private void
flush
(boolean lastFragment, boolean batch) Flushes the current contents of the buffer as one fragment to the network.Returns the Internet address of the sender of the current XDR data.int
Returns the port number of the sender of the current XDR data.void
xdrEncodeInt
(int value) Encodes (aka "serializes") a "XDR int" value and writes it down a XDR stream.void
xdrEncodeOpaque
(byte[] value, int offset, int length) Encodes (aka "serializes") a XDR opaque value, which is represented by a vector of byte values, and starts atoffset
with a length oflength
.Methods inherited from class org.acplt.oncrpc.XdrEncodingStream
getCharacterEncoding, setCharacterEncoding, xdrEncodeBoolean, xdrEncodeBooleanFixedVector, xdrEncodeBooleanVector, xdrEncodeByte, xdrEncodeByteFixedVector, xdrEncodeByteVector, xdrEncodeDouble, xdrEncodeDoubleFixedVector, xdrEncodeDoubleVector, xdrEncodeDynamicOpaque, xdrEncodeFloat, xdrEncodeFloatFixedVector, xdrEncodeFloatVector, xdrEncodeIntFixedVector, xdrEncodeIntVector, xdrEncodeLong, xdrEncodeLongFixedVector, xdrEncodeLongVector, xdrEncodeOpaque, xdrEncodeOpaque, xdrEncodeShort, xdrEncodeShortFixedVector, xdrEncodeShortVector, xdrEncodeString, xdrEncodeStringFixedVector, xdrEncodeStringVector
-
Field Details
-
socket
The streaming socket to be used when receiving this XDR stream's buffer contents. -
stream
OutputStream streamThe output stream used to get rid of bytes going off to the network. -
buffer
private byte[] bufferThe buffer which will be filled from the datagram socket and then be used to supply the information when decoding data. -
bufferIndex
private int bufferIndexThe write pointer is an index into thebuffer
. -
bufferHighmark
private int bufferHighmarkIndex of the last four byte word in thebuffer
. -
bufferFragmentHeaderIndex
private int bufferFragmentHeaderIndexIndex of fragment header withinbuffer
. -
paddingZeros
private static final byte[] paddingZerosSome zeros, only needed for padding -- like in real life.
-
-
Constructor Details
-
XdrTcpEncodingStream
Construct a newXdrTcpEncodingStream
object and associate it with the givenstreamingSocket
for TCP/IP-based communication.- Parameters:
streamingSocket
- Socket to which XDR data is sent.bufferSize
- Size of packet buffer for temporarily storing outgoing XDR data.- Throws:
IOException
-
-
Method Details
-
getSenderAddress
Returns the Internet address of the sender of the current XDR data. This method should only be called afterbeginEncoding(java.net.InetAddress, int)
, otherwise it might return stale information.- Returns:
- InetAddress of the sender of the current XDR data.
-
getSenderPort
public int getSenderPort()Returns the port number of the sender of the current XDR data. This method should only be called afterbeginEncoding(java.net.InetAddress, int)
, otherwise it might return stale information.- Returns:
- Port number of the sender of the current XDR data.
-
beginEncoding
public void beginEncoding(InetAddress receiverAddress, int receiverPort) throws OncRpcException, IOException Begins encoding a new XDR record. This typically involves resetting this encoding XDR stream back into a known state.- Overrides:
beginEncoding
in classXdrEncodingStream
- Parameters:
receiverAddress
- Indicates the receiver of the XDR data. This can benull
for XDR streams connected permanently to a receiver (like in case of TCP/IP based XDR streams).receiverPort
- Port number of the receiver.- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
endEncoding
Flushes this encoding XDR stream and forces any buffered output bytes to be written out. The general contract ofendEncoding
is that calling it is an indication that the current record is finished and any bytes previously encoded should immediately be written to their intended destination.- Overrides:
endEncoding
in classXdrEncodingStream
- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
endEncoding
Ends the current record fort this encoding XDR stream. If the parameterflush
istrue
any buffered output bytes are immediately written to their intended destination. Ifflush
isfalse
, then more than one record can be pipelined, for instance, to batch several ONC/RPC calls. In this case the ONC/RPC server must not send a reply (with the exception for the last call in a batch, which might be trigger a reply). Otherwise, you will most probably cause an interaction deadlock between client and server.- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
flush
Flushes the current contents of the buffer as one fragment to the network.- Parameters:
lastFragment
-true
if this is the last fragment of the current XDR record.batch
- if last fragment andbatch
istrue
, then the buffer is not flushed to the network but instead we wait for more records to be encoded.- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
close
Closes this encoding XDR stream and releases any system resources associated with this stream. The general contract ofclose
is that it closes the encoding XDR stream. A closed XDR stream cannot perform encoding operations and cannot be reopened.- Overrides:
close
in classXdrEncodingStream
- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
xdrEncodeInt
Encodes (aka "serializes") a "XDR int" value and writes it down a XDR stream. A XDR int is 32 bits wide -- the same width Java's "int" data type has. This method is one of the basic methods all other methods can rely on.- Specified by:
xdrEncodeInt
in classXdrEncodingStream
- Parameters:
value
- The int value to be encoded.- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-
xdrEncodeOpaque
public void xdrEncodeOpaque(byte[] value, int offset, int length) throws OncRpcException, IOException Encodes (aka "serializes") a XDR opaque value, which is represented by a vector of byte values, and starts atoffset
with a length oflength
. Only the opaque value is encoded, but no length indication is preceeding the opaque value, so the receiver has to know how long the opaque value will be. The encoded data is always padded to be a multiple of four. If the given length is not a multiple of four, zero bytes will be used for padding.- Specified by:
xdrEncodeOpaque
in classXdrEncodingStream
- Parameters:
value
- The opaque value to be encoded in the form of a series of bytes.offset
- Start offset in the data.length
- the number of bytes to encode.- Throws:
OncRpcException
- if an ONC/RPC error occurs.IOException
- if an I/O error occurs.
-