All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.omg.CORBA.Request

java.lang.Object
   |
   +----org.omg.CORBA.Request

public abstract class Request
extends Object

Java Class org.omg.CORBA.Request
Source File org/omg/CORBA/Request.java
IDL Source File corba.idl
IDL Absolute Name ::CORBA::Request
Repository Identifier IDL:omg.org/CORBA/Request:1.0

IDL definition:

interface Request {
readonly attribute ::CORBA::Object target;
readonly attribute ::CORBA::Identifier operation;
readonly attribute ::CORBA::NVList arguments;
readonly attribute ::CORBA::NamedValue result;
readonly attribute ::CORBA::Environment env;
readonly attribute ::CORBA::ExceptionList exceptions;
readonly attribute ::CORBA::ContextList contexts;
attribute ::CORBA::Context ctx;
any add_in_arg();
any add_named_in_arg(
in string name
);
any add_inout_arg();
any add_named_inout_arg(
in string name
);
any add_out_arg();
any add_named_out_arg(
in string name
);
void set_return_type(
in ::CORBA::TypeCode tc
);
any return_value();
void invoke();
void send_oneway();
void send_deferred();
void get_response(
)
raises(
::CORBA::WrongTransaction
);
boolean poll_response();
};

The Request interface defines a dynamic invocation. This object encapsulates all the state required to make a request, including:

The target object
The operation name
The argument types and values
The return type and value
The environment, containing exceptions
The context

Furthermore, the request interface provides multiple invocation operations, allowing for both synchronous and asynchronous invocations. Asynchronous invocation can be made on both oneway and normal requests. Replies to invocations can then be polled or obtained synchronously. The ORB interface can also be used to do multiple simultaneous invocations, allowing for higher parallelism and reduced latency.

Request()

add_in_arg(): Operation: ::CORBA::Request::add_in_arg.
add_inout_arg(): Operation: ::CORBA::Request::add_inout_arg.
add_named_in_arg(String): Operation: ::CORBA::Request::add_named_in_arg.
add_named_inout_arg(String): Operation: ::CORBA::Request::add_named_inout_arg.
add_named_out_arg(String): Operation: ::CORBA::Request::add_named_out_arg.
add_out_arg(): Operation: ::CORBA::Request::add_out_arg.
arguments(): Get the list of arguments to the request.
contexts(): Get the list of context names.
ctx(): Set or get the context of the request.
ctx(Context): Set or get the context of the request.
env(): Get the environment in which the operation is invoked.
exceptions(): Get the list of user exception type codes.
get_response(): Waits for the results of a deferred invocation (e.g., a call to send_deferred to complete, and updates the inout, out, and return values.
invoke(): Invoke the operation synchronously.
operation(): Get the request's operation name (or method name).
poll_response(): Returns true if the response to the asynchronous invocation is available, false otherwise.
result(): Get the result (return value) of the request.
return_value(): Operation: ::CORBA::Request::return_value.
send_deferred(): Invoke a non-oneway operation asynchronously.
send_oneway(): Invoke a oneway operation.
set_return_type(TypeCode): Operation: ::CORBA::Request::set_return_type.
target(): Get the target object to which the request will be sent.

Request

 public Request()

target

 public abstract Object target()

Get the target object to which the request will be sent.

Reader for attribute: ::CORBA::Request::target.

readonly attribute ::CORBA::Object target;

operation

 public abstract String operation()

Get the request's operation name (or method name).

Reader for attribute: ::CORBA::Request::operation.

readonly attribute ::CORBA::Identifier operation;

arguments

 public abstract NVList arguments()

Get the list of arguments to the request. This argument list must be initialized prior to sending the request.

Reader for attribute: ::CORBA::Request::arguments.

readonly attribute ::CORBA::NVList arguments;

result

 public abstract NamedValue result()

Get the result (return value) of the request. If the type of the result is not specified, it defaults to void. If the return type is not void, the type must be initialized prior to sending the request.

Reader for attribute: ::CORBA::Request::result.

readonly attribute ::CORBA::NamedValue result;

env

 public abstract Environment env()

Get the environment in which the operation is invoked. Exceptions raised by the server will be put into the request's environment.

Reader for attribute: ::CORBA::Request::env.

readonly attribute ::CORBA::Environment env;

exceptions

 public abstract ExceptionList exceptions()

Get the list of user exception type codes. This will be an empty list if no user exceptions can be raised by the operation.

Reader for attribute: ::CORBA::Request::exceptions.

readonly attribute ::CORBA::ExceptionList exceptions;

contexts

 public abstract ContextList contexts()

Get the list of context names. This will be an empty list if the operation does not specify any contexts.

Reader for attribute: ::CORBA::Request::contexts.

readonly attribute ::CORBA::ContextList contexts;

ctx

 public abstract void ctx(Context ctx)

Set or get the context of the request.

Writer for attribute: ::CORBA::Request::ctx.

attribute ::CORBA::Context ctx;

See Also:: get_default_context

ctx

 public abstract Context ctx()

Set or get the context of the request.

Reader for attribute: ::CORBA::Request::ctx.

attribute ::CORBA::Context ctx;

See Also:: get_default_context

add_in_arg

 public abstract Any add_in_arg()

Operation: ::CORBA::Request::add_in_arg.

any add_in_arg();

add_named_in_arg

 public abstract Any add_named_in_arg(String name)

Operation: ::CORBA::Request::add_named_in_arg.

any add_named_in_arg(
in string name
);

add_inout_arg

 public abstract Any add_inout_arg()

Operation: ::CORBA::Request::add_inout_arg.

any add_inout_arg();

add_named_inout_arg

 public abstract Any add_named_inout_arg(String name)

Operation: ::CORBA::Request::add_named_inout_arg.

any add_named_inout_arg(
in string name
);

add_out_arg

 public abstract Any add_out_arg()

Operation: ::CORBA::Request::add_out_arg.

any add_out_arg();

add_named_out_arg

 public abstract Any add_named_out_arg(String name)

Operation: ::CORBA::Request::add_named_out_arg.

any add_named_out_arg(
in string name
);

set_return_type

 public abstract void set_return_type(TypeCode tc)

Operation: ::CORBA::Request::set_return_type.

void set_return_type(
in ::CORBA::TypeCode tc
);

return_value

 public abstract Any return_value()

Operation: ::CORBA::Request::return_value.

any return_value();

invoke

 public abstract void invoke()

Invoke the operation synchronously.

Operation: ::CORBA::Request::invoke.

void invoke();

send_oneway

 public abstract void send_oneway()

Invoke a oneway operation.

Operation: ::CORBA::Request::send_oneway.

void send_oneway();

See Also:: send_multiple_requests_oneway

send_deferred

 public abstract void send_deferred()

Invoke a non-oneway operation asynchronously. Results from the operation can be polled and obtained via poll_response and get_response. The values in inout, out, and return values will not be valid until get_response returns.

Operation: ::CORBA::Request::send_deferred.

void send_deferred();

See Also:: send_multiple_requests_deferred

get_response

 public abstract void get_response() throws WrongTransaction

Waits for the results of a deferred invocation (e.g., a call to send_deferred to complete, and updates the inout, out, and return values.

Operation: ::CORBA::Request::get_response.

void get_response(
)
raises(
::CORBA::WrongTransaction
);

Throws: WrongTransaction: is thrown if get_response was invoked from a different transaction's scope than the one from which the request was originally sent. See the OMG Transaction Service specification for details.
See Also:: get_next_response

poll_response

 public abstract boolean poll_response()

Returns true if the response to the asynchronous invocation is available, false otherwise. Note that get_response must be called even if poll_response returns true, since get_response actual reads in the result values.

Operation: ::CORBA::Request::poll_response.

boolean poll_response();

See Also:: poll_next_response

All Packages  Class Hierarchy  This Package  Previous  Next  Index