TAO::Invocation_Base Class Reference

The base class for the invocation object. More...

#include <Invocation_Base.h>

Inheritance diagram for TAO::Invocation_Base:

Inheritance graph
[legend]
Collaboration diagram for TAO::Invocation_Base:

Collaboration graph
[legend]
List of all members.
size_t & stack_size (void)
CORBA::Exceptioncaught_exception (void)
TAO::Invocation_Status invoke_status (void) const
 Invoke status.
PortableInterceptor::ReplyStatus reply_status (void) const
bool is_remote_request () const
void exception CORBA::Exceptionexception
 Change the exception status.
Invocation_Status send_request_interception () throw (CORBA::SystemException)
Invocation_Status receive_reply_interception () throw (CORBA::SystemException)
Invocation_Status receive_other_interception () throw (CORBA::SystemException)
PortableInterceptor::ReplyStatus handle_any_exception (CORBA::Exception *e)
PortableInterceptor::ReplyStatus handle_all_exception ()
ClientRequestInterceptor_Adapteradapter_
 The client requestor adapter.
size_t stack_size_
TAO::Invocation_Status invoke_status_
CORBA::Exceptioncaught_exception_
 Pointer to the caught exception.
bool is_remote_request_

Public Member Functions

virtual ~Invocation_Base (void)
TAO_ORB_Coreorb_core (void) const
 Accessor and mutator methods.
TAO_Stubstub (void) const
 Accessor and mutator methods.
CORBA::Object_ptr forwarded_reference (void)
void forwarded_reference (CORBA::Object_ptr o)
 Accessor and mutator methods.
TAO_Service_Contextrequest_service_context (void)
 Accessors for the service context list.
TAO_Service_Contextreply_service_context (void)
 Accessor and mutator methods.
CORBA::Object_ptr steal_forwarded_reference (void)
 Return the forwarded object location by loosing ownership.
bool is_forwarded (void) const
 Did the invocation got forwarded to a new location?
void reply_received (Invocation_Status s)
 Mutator to set the reply status of the invocation.
CORBA::Object_ptr effective_target (void) const
 Return the effective target of the invocation.
CORBA::Object_ptr target (void) const
 Return the target object.
CORBA::Boolean response_expected (void) const
 Does this invocation return a response?
TAO_Operation_Detailsoperation_details (void)
 The operaton details of the invocation.

Protected Member Functions

 Invocation_Base (CORBA::Object_ptr otarget, CORBA::Object_ptr target, TAO_Stub *stub, TAO_Operation_Details &op, bool response_expected, bool request_is_remote)

Protected Attributes

TAO_Operation_Detailsdetails_
 The operation details on which we are operating on.
CORBA::Object_var forwarded_to_
 Forwarded object reference.
bool response_expected_
 Is response expected?

Private Member Functions

 Invocation_Base (const Invocation_Base &)
Invocation_Baseoperator= (const Invocation_Base &)

Private Attributes

CORBA::Object_ptr otarget_
 The original target on which the invocation was started.
CORBA::Object_ptr target_
 The effective target on which the invocation is on.
TAO_ORB_Coreorb_core_
 Cache the ORB_Core.
TAO_Stubstub_
 The original target on which the invocation was started.

Detailed Description

The base class for the invocation object.

This class is the base of the invocation object hiererachy. This hierarchy is classified based on the type of invocation and the mode of invocation. One of the objects from the hierarchy is created on the stack for every invocation.

In addition this class encapsulates the essential details that are required for PortableInterceptors to function correctly. Further this class also provides some helper and accessor methods that are used by clients.


Constructor & Destructor Documentation

TAO::Invocation_Base::~Invocation_Base ( void   )  [virtual]

TAO::Invocation_Base::Invocation_Base ( CORBA::Object_ptr  otarget,
CORBA::Object_ptr  target,
TAO_Stub stub,
TAO_Operation_Details op,
bool  response_expected,
bool  request_is_remote 
) [protected]

Parameters:
otarget The original target on which this invocation was started.
target the target on which this invocation is flowing ie. the effective target
op operation details of the invocation on target
response_expected flag to indicate whether the operation encapsulated by op returns a response or not.

TAO::Invocation_Base::Invocation_Base ( const Invocation_Base  )  [private]


Member Function Documentation

CORBA::Exception* TAO::Invocation_Base::caught_exception ( void   ) 

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

ACE_INLINE CORBA::Object_ptr TAO::Invocation_Base::effective_target ( void   )  const

Return the effective target of the invocation.

Please see the PortableInterceptor specification in the CORBA spec to understand what effective target means.

ACE_INLINE void TAO::Invocation_Base::forwarded_reference ( CORBA::Object_ptr  o  ) 

Accessor and mutator methods.

ACE_INLINE CORBA::Object_ptr TAO::Invocation_Base::forwarded_reference ( void   ) 

These access methods have to be public so that the PortableInterceptor can use them

PortableInterceptor::ReplyStatus TAO::Invocation_Base::handle_all_exception (  )  [protected]

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

PortableInterceptor::ReplyStatus TAO::Invocation_Base::handle_any_exception ( CORBA::Exception e  )  [protected]

Helper methods to handle interception calls when exceptions are thrown by the PortableInterceptor.

TAO::Invocation_Status TAO::Invocation_Base::invoke_status ( void   )  const

Invoke status.

ACE_INLINE bool TAO::Invocation_Base::is_forwarded ( void   )  const

Did the invocation got forwarded to a new location?

bool TAO::Invocation_Base::is_remote_request (  )  const

Accessor used to determine if the current invocation is part of a remote request, and if not, it will be considered to be part of a collocated request.

ACE_INLINE TAO_Operation_Details & TAO::Invocation_Base::operation_details ( void   ) 

The operaton details of the invocation.

Invocation_Base& TAO::Invocation_Base::operator= ( const Invocation_Base  )  [private]

ACE_INLINE TAO_ORB_Core * TAO::Invocation_Base::orb_core ( void   )  const

Accessor and mutator methods.

Invocation_Status TAO::Invocation_Base::receive_other_interception (  )  throw (CORBA::SystemException) [protected]

Helper method to invoke receive_other interception call to all the registered interceptors.

Invocation_Status TAO::Invocation_Base::receive_reply_interception (  )  throw (CORBA::SystemException) [protected]

Helper method to invoke receive_reply interception call to all the registered interceptors.

void TAO::Invocation_Base::reply_received ( Invocation_Status  s  ) 

Mutator to set the reply status of the invocation.

TAO_Service_Context & TAO::Invocation_Base::reply_service_context ( void   ) 

Accessor and mutator methods.

PortableInterceptor::ReplyStatus TAO::Invocation_Base::reply_status ( void   )  const

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

TAO_Service_Context & TAO::Invocation_Base::request_service_context ( void   ) 

Accessors for the service context list.

The service context lists are actually cached elsewhere. Providing this accessor helps the PI to access this list in both remote and collocated mode.

ACE_INLINE CORBA::Boolean TAO::Invocation_Base::response_expected ( void   )  const

Does this invocation return a response?

Invocation_Status TAO::Invocation_Base::send_request_interception (  )  throw (CORBA::SystemException) [protected]

Helper method to invoke send_request interception call to all the registered interceptors.

size_t& TAO::Invocation_Base::stack_size ( void   ) 

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

ACE_INLINE CORBA::Object_ptr TAO::Invocation_Base::steal_forwarded_reference ( void   ) 

Return the forwarded object location by loosing ownership.

ACE_INLINE TAO_Stub * TAO::Invocation_Base::stub ( void   )  const

Accessor and mutator methods.

ACE_INLINE CORBA::Object_ptr TAO::Invocation_Base::target ( void   )  const

Return the target object.


Member Data Documentation

ClientRequestInterceptor_Adapter* TAO::Invocation_Base::adapter_ [protected]

The client requestor adapter.

CORBA::Exception* TAO::Invocation_Base::caught_exception_ [private]

Pointer to the caught exception.

TAO_Operation_Details& TAO::Invocation_Base::details_ [protected]

The operation details on which we are operating on.

void TAO::Invocation_Base::exception

Change the exception status.

CORBA::Object_var TAO::Invocation_Base::forwarded_to_ [protected]

Forwarded object reference.

TAO::Invocation_Status TAO::Invocation_Base::invoke_status_ [protected]

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

bool TAO::Invocation_Base::is_remote_request_ [private]

Flag used to distinguish a remote invocation versus a collocated (thru-poa) invocation.

TAO_ORB_Core* TAO::Invocation_Base::orb_core_ [private]

Cache the ORB_Core.

CORBA::Object_ptr TAO::Invocation_Base::otarget_ [private]

The original target on which the invocation was started.

The following object reference pointers are *not* duplicated. They are cached for portable interceptors, and they just live for the lifetime of the request. Hence there is no point in duplicating the pointers.

bool TAO::Invocation_Base::response_expected_ [protected]

Is response expected?

size_t TAO::Invocation_Base::stack_size_ [protected]

Note:
It is a reference since the Portable Interceptor flow stack code must be able to modify this value and use that value at a later time without being forced to use TSS.

TAO_Stub* TAO::Invocation_Base::stub_ [private]

The original target on which the invocation was started.

The following object reference pointers are *not* duplicated. They are cached for portable interceptors, and they just live for the lifetime of the request. Hence there is no point in duplicating the pointers.

CORBA::Object_ptr TAO::Invocation_Base::target_ [private]

The effective target on which the invocation is on.


The documentation for this class was generated from the following files:
Generated on Wed Apr 19 03:23:59 2006 for TAO by  doxygen 1.4.6-4