RemoteCall (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.rmi.server
interface RemoteCall

public interface RemoteCall

RemoteCall is an abstraction used solely by the RMI runtime (in conjunction with stubs and skeletons of remote objects) to carry out a call to a remote object. The RemoteCall interface is deprecated because it is only used by deprecated methods of java.rmi.server.RemoteRef.

Method Summary
`void`	`done()` Allow cleanup after the remote call has completed.
`void`	`executeCall()` Do whatever it takes to execute the call.
`ObjectInput`	`getInputStream()` Get the InputStream that the stub/skeleton should get results/arguments from.
`ObjectOutput`	`getOutputStream()` Return the output stream the stub/skeleton should put arguments/results into.
`ObjectOutput`	`getResultStream(boolean success)` Returns an output stream (may put out header information relating to the success of the call).
`void`	`releaseInputStream()` Release the input stream.
`void`	`releaseOutputStream()` Release the output stream; in some transports this would release the stream.

Method Detail

done

public void done()
          throws IOException

Allow cleanup after the remote call has completed.

Throws:: IOException - if an I/O error occurs.

executeCall

public void executeCall()
                 throws Exception

Do whatever it takes to execute the call.

Throws:: Exception - if a general exception occurs.

getInputStream

public ObjectInput getInputStream()
                           throws IOException

Get the InputStream that the stub/skeleton should get results/arguments from.

Returns:: input stream for reading arguments/results
Throws:: IOException - if an I/O error occurs.

getOutputStream

public ObjectOutput getOutputStream()
                             throws IOException

Return the output stream the stub/skeleton should put arguments/results into.

Returns:: output stream for arguments/results
Throws:: IOException - if an I/O error occurs.

getResultStream

public ObjectOutput getResultStream(boolean success)
                             throws IOException,
                                    StreamCorruptedException

Returns an output stream (may put out header information relating to the success of the call). Should only succeed once per remote call.

Parameters:: success - If true, indicates normal return, else indicates exceptional return.
Returns:: output stream for writing call result
Throws:: IOException - if an I/O error occurs.; StreamCorruptedException - If already been called.

releaseInputStream

public void releaseInputStream()
                        throws IOException

Release the input stream. This would allow some transports to release the channel early.

Throws:: IOException - if an I/O error occurs.

releaseOutputStream

public void releaseOutputStream()
                         throws IOException

Release the output stream; in some transports this would release the stream.

Throws:: IOException - if an I/O error occurs.