Class org.omg.CORBA.Request
All Packages Class Hierarchy This Package Previous Next Index
Class org.omg.CORBA.Request
java.lang.Object
|
+----org.omg.CORBA.Request
- public class Request
- extends Object
The Request pseudo-object is the cornerstone of the ORB Dynamic
Invocation interface (DII). The DII allows dynamic creation and
invocation of requests to objects. A client using this interface to
send a request to an object obtains the same semantics as a client
using the operation stub generated from the type specification. A
request consists of an object reference, an operation, and a list
of parameters. The ORB applies the implementation-hiding
(encapsulation) principle to requests. In the Dynamic Invocation
interface, parameters in a request are supplied as elements of a
list. Each element is an instance of a NamedValue. Each parameter
is passed in its native data form.
- See Also:
- NamedValue
-
Request()
-
-
add_in_arg()
- The add_in_arg operation adds an "in" argument.
-
add_in_arg(String)
- The add_in_arg operation adds an "in" argument with the given name.
-
add_inout_arg()
- The add_inout_arg operation adds an "inout" argument.
-
add_inout_arg(String)
- The add_inout_arg operation adds an "inout" argument with the given name.
-
add_out_arg()
- The add_out_arg operation adds an "out" argument.
-
add_out_arg(String)
- The add_out_arg operation adds an "out" argument with the given name.
-
arguments()
- The arguments accessor
-
contexts()
- The context list accessor
-
ctx()
- The context object accessor
-
ctx(Context)
- The context object modifier
-
env()
- The environment accessor
-
exceptions()
- The exceptions accessor
-
get_response()
- The get_response operation supports the asynchronous invocation
mechanism (send_deferred).
-
invoke()
- The invoke operation does a synchronous invocation using the
information in the Request object.
-
operation()
- The operation name accessor
-
poll_response()
- The poll_response operation supports the asynchronous invocation
mechanism (send_deferred).
-
result()
- The result accessor
-
return_value()
- The return_value operation returns the Any that contains the
result of the operation.
-
send_deferred()
- The send_deferred operation does an asynchronous invocation on
the request.
-
send_oneway()
- The send_oneway operation does a oneway invocation on the
request.
-
set_return_type(TypeCode)
- The set_return_type operation sets the typecode for the result
value of the operation.
-
target()
- The target accessor
Request
public Request()
target
public abstract Object target() throws SystemException
- The target accessor
- Returns:
- the target object reference on which
operation is to be invoked.
operation
public abstract String operation() throws SystemException
- The operation name accessor
- Returns:
- the name of the operation to be invoked
arguments
public abstract NVList arguments() throws SystemException
- The arguments accessor
- Returns:
- the arguments of the operation, in the
form of an NVList.
result
public abstract NamedValue result() throws SystemException
- The result accessor
- Returns:
- the NamedValue containing the result
of the operation.
env
public abstract Environment env() throws SystemException
- The environment accessor
- Returns:
- the environment object that will contain
information about any exceptions that might
might be returned on invocation of the
request
exceptions
public abstract ExceptionList exceptions() throws SystemException
- The exceptions accessor
- Returns:
- the list of exceptions the operation
might throw
contexts
public abstract ContextList contexts() throws SystemException
- The context list accessor
- Returns:
- the list of context strings whose values
need to be resolved and sent with the
invocation.
ctx
public abstract Context ctx() throws SystemException
- The context object accessor
- Returns:
- the context object that is to be used
to resolve any context strings whose
values need to be sent with the invocation.
ctx
public abstract void ctx(Context newCtx) throws SystemException
- The context object modifier
- Parameters:
- newCtx - the new context object to be used for
resolving context strings.
add_in_arg
public abstract Any add_in_arg() throws SystemException
- The add_in_arg operation adds an "in" argument.
- Returns:
- an Any representing the holder for the
argument added.
add_in_arg
public abstract Any add_in_arg(String name) throws SystemException
- The add_in_arg operation adds an "in" argument with the given name.
- Parameters:
- name - the name of the argument being added.
- Returns:
- an Any representing the holder for the
argument added.
add_inout_arg
public abstract Any add_inout_arg() throws SystemException
- The add_inout_arg operation adds an "inout" argument.
- Returns:
- an Any representing the holder for the
argument added.
add_inout_arg
public abstract Any add_inout_arg(String name) throws SystemException
- The add_inout_arg operation adds an "inout" argument with the given name.
- Parameters:
- name - the name of the argument being added.
- Returns:
- an Any representing the holder for the
argument added.
add_out_arg
public abstract Any add_out_arg() throws SystemException
- The add_out_arg operation adds an "out" argument.
- Returns:
- an Any representing the holder for the
argument added.
add_out_arg
public abstract Any add_out_arg(String name) throws SystemException
- The add_out_arg operation adds an "out" argument with the given name.
- Parameters:
- name - the name of the argument being added.
- Returns:
- an Any representing the holder for the
argument added.
set_return_type
public abstract void set_return_type(TypeCode tc) throws SystemException
- The set_return_type operation sets the typecode for the result
value of the operation.
- Parameters:
- tc - typecode for the result value.
return_value
public abstract Any return_value() throws SystemException
- The return_value operation returns the Any that contains the
result of the operation.
invoke
public abstract void invoke() throws SystemException
- The invoke operation does a synchronous invocation using the
information in the Request object. Exception information is
placed into the Request environment object.
send_oneway
public abstract void send_oneway() throws SystemException
- The send_oneway operation does a oneway invocation on the
request. In other words, it does not expect or wait for a
response. Note that this can be used even if the operation was
not declared as oneway in the IDL declaration. No response or
exception information is returned.
send_deferred
public abstract void send_deferred() throws SystemException
- The send_deferred operation does an asynchronous invocation on
the request. In other words, it does not wait for response, but
returns to the user. The user can then use the poll_response and
get_response methods to later get the result or exception
information for the invocation.
poll_response
public abstract boolean poll_response() throws SystemException
- The poll_response operation supports the asynchronous invocation
mechanism (send_deferred). It allows the user to determine
whether a response has been received for the invocation triggered
earlier with the 'send_deferred' operation.
- Returns:
- true if the operation response has
been received, false otherwise.
get_response
public abstract void get_response() throws SystemException
- The get_response operation supports the asynchronous invocation
mechanism (send_deferred). It allows the user to access the
response for the invocation triggered earlier with the
'send_deferred' operation.
All Packages Class Hierarchy This Package Previous Next Index