TAO_ClientRequestInfo Class Reference

Implementation of the PortableInterceptor::ClientRequestInfo interface. More...

#include <ClientRequestInfo.h>

Inheritance diagram for TAO_ClientRequestInfo:

Inheritance graph
[legend]
Collaboration diagram for TAO_ClientRequestInfo:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TAO_ClientRequestInfo (void)
virtual CORBA::ULong request_id (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual char * operation (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 Return the operation name for the current request.
virtual Dynamic::ParameterListarguments (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 Return the list of arguments passed to the current operation.
virtual Dynamic::ExceptionListexceptions (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual Dynamic::ContextListcontexts (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual Dynamic::RequestContextoperation_context (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Anyresult (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Boolean response_expected (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 Returns true for a two-way operation, and false otherwise.
virtual Messaging::SyncScope sync_scope (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual PortableInterceptor::ReplyStatus reply_status (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 Return the reply status for the current request.
virtual CORBA::Object_ptr forward_reference (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Anyget_slot (PortableInterceptor::SlotId id ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, PortableInterceptor::InvalidSlot)
virtual IOP::ServiceContextget_request_service_context (IOP::ServiceId id ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual IOP::ServiceContextget_reply_service_context (IOP::ServiceId id ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Object_ptr target (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Object_ptr effective_target (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual IOP::TaggedProfileeffective_profile (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Anyreceived_exception (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual char * received_exception_id (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 Return the repository ID for the received exception.
virtual IOP::TaggedComponentget_effective_component (IOP::ComponentId id ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual IOP::TaggedComponentSeqget_effective_components (IOP::ComponentId id ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual CORBA::Policy_ptr get_request_policy (CORBA::PolicyType type ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual void add_request_service_context (const IOP::ServiceContext &service_context, CORBA::Boolean replace ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
void info (TAO_ClientRequestInfo_i *info)
TAO_ClientRequestInfo_iinfo (void) const
TAO_GIOP_Invocation * invocation ()
 Accessor to underlying invocation_.

Private Member Functions

void check_validity (ACE_ENV_SINGLE_ARG_DECL)

Private Attributes

TAO_ClientRequestInfo_iinfo_
TAO_GIOP_Invocation * invocation_
 Pointer to the GIOP invocation object.

Detailed Description

Implementation of the PortableInterceptor::ClientRequestInfo interface.

This class forwards all method calls to the underlying ClientRequestInfo implementation.

An instance of this class is placed in TSS, where as the underlying implementation is instantiated on the stack during each CORBA request. During each request invocation, a pointer to the stack instantiated implementation is placed in the instance of this class.
This may seem unnecessary. However, it is necessary to avoid instantiating an object that inherits from CORBA::Object in the critical path. Such an instantiation would cause a lock to be initialized (not acquired) in the critical path, which can degrade performance significantly.


Constructor & Destructor Documentation

TAO_ClientRequestInfo::TAO_ClientRequestInfo void   ) 
 


Member Function Documentation

void TAO_ClientRequestInfo::add_request_service_context const IOP::ServiceContext service_context,
CORBA::Boolean replace  ACE_ENV_ARG_DECL_WITH_DEFAULTS
throw (CORBA::SystemException) [virtual]
 

Add the IOP::ServiceContext to the request (outgoing) IOP::ServiceContextList.

virtual Dynamic::ParameterList* TAO_ClientRequestInfo::arguments ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the list of arguments passed to the current operation.

ACE_INLINE void TAO_ClientRequestInfo::check_validity ACE_ENV_SINGLE_ARG_DECL   )  [private]
 

Check if this ClientRequestInfo object is called within the context of a request.

virtual Dynamic::ContextList* TAO_ClientRequestInfo::contexts ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

virtual IOP::TaggedProfile* TAO_ClientRequestInfo::effective_profile ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

virtual CORBA::Object_ptr TAO_ClientRequestInfo::effective_target ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the object reference for the current target. The target may change in the even of a location forward.

virtual Dynamic::ExceptionList* TAO_ClientRequestInfo::exceptions ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the list of exceptions the current operation is capable of throwing.

virtual CORBA::Object_ptr TAO_ClientRequestInfo::forward_reference ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

If the reply status is PortableInterceptor::LOCATION_FORWARD or PortableInterceptor::LOCATION_FORWARD_PERMANENT, return the object reference to which the request was forwarded.

IOP::TaggedComponent * TAO_ClientRequestInfo::get_effective_component IOP::ComponentId id  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

Return the first IOP::TaggedComponent that matches the given IOP::ComponentId in the object reference for the current target.

IOP::TaggedComponentSeq * TAO_ClientRequestInfo::get_effective_components IOP::ComponentId id  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

Return all IOP::TaggedComponent(s) that match the given IOP::ComponentId in the object reference for the current target.

IOP::ServiceContext * TAO_ClientRequestInfo::get_reply_service_context IOP::ServiceId id  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

Return the IOP::ServiceContext with the given IOP::ServiceId from the reply service context list.

CORBA::Policy_ptr TAO_ClientRequestInfo::get_request_policy CORBA::PolicyType type  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

Return the policy of the given type in effect for the current request.

IOP::ServiceContext * TAO_ClientRequestInfo::get_request_service_context IOP::ServiceId id  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

Return the IOP::ServiceContext with the given IOP::ServiceId from the request service context list.

CORBA::Any * TAO_ClientRequestInfo::get_slot PortableInterceptor::SlotId id  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException, PortableInterceptor::InvalidSlot) [virtual]
 

ACE_INLINE TAO_ClientRequestInfo_i * TAO_ClientRequestInfo::info void   )  const
 

Get the ClientRequestInfo implementation which this class forwards all method call to.

ACE_INLINE void TAO_ClientRequestInfo::info TAO_ClientRequestInfo_i info  ) 
 

Set the ClientRequestInfo implementation which this class forwards all method call to.

TAO_GIOP_Invocation * TAO_ClientRequestInfo::invocation  ) 
 

Accessor to underlying invocation_.

virtual char* TAO_ClientRequestInfo::operation ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the operation name for the current request.

virtual Dynamic::RequestContext* TAO_ClientRequestInfo::operation_context ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

virtual CORBA::Any* TAO_ClientRequestInfo::received_exception ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Note:
There is no trivial way to extract the exception from an Any.

virtual char* TAO_ClientRequestInfo::received_exception_id ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the repository ID for the received exception.

virtual PortableInterceptor::ReplyStatus TAO_ClientRequestInfo::reply_status ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the reply status for the current request.

Statuses can be PortableInterceptor::SUCCESSFUL, SYSTEM_EXCEPTION, USER_EXCEPTION, LOCATION_FORWARD, LOCATION_FORWARD_PERMANENT, TRANSPORT_RETRY, UNKNOWN.

virtual CORBA::ULong TAO_ClientRequestInfo::request_id ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return an ID unique to the current request. This request ID may or may not be the same as the GIOP request ID.

virtual CORBA::Boolean TAO_ClientRequestInfo::response_expected ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Returns true for a two-way operation, and false otherwise.

virtual CORBA::Any* TAO_ClientRequestInfo::result ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the result of the current request. If there is no return value then an Any with tk_void TypeCode is returned. This is method is not valid for oneway operations.

virtual Messaging::SyncScope TAO_ClientRequestInfo::sync_scope ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the sync_scope policy value for the current one-way operation. If the operation is not a one-way, a CORBA::BAD_INV_ORDER exception is thrown.

virtual CORBA::Object_ptr TAO_ClientRequestInfo::target ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

Return the (initial, non-forwarded, or permanently forwarded) object reference of the target.


Member Data Documentation

TAO_ClientRequestInfo_i* TAO_ClientRequestInfo::info_ [private]
 

Pointer to the object that actually implements the ClientRequestInfo functionality.

TAO_GIOP_Invocation* TAO_ClientRequestInfo::invocation_ [private]
 

Pointer to the GIOP invocation object.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 16:01:59 2005 for TAO by  doxygen 1.4.5