TAO::ServerRequestInfo Class Reference

Implementation of the PortableInterceptor::ServerRequestInfo IDL interface. More...

#include <ServerRequestInfo.h>

Inheritance diagram for TAO::ServerRequestInfo:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ServerRequestInfo (TAO_ServerRequest &server_request, TAO::Argument *const *args, size_t nargs, void *servant_upcall, CORBA::TypeCode_ptr const *exceptions, CORBA::ULong nexceptions)
 Constructor.
virtual CORBA::ULong request_id (void)
virtual char * operation (void)
 Return the operation name for the current request.
virtual Dynamic::ParameterList * arguments (void)
 Return the list of arguments passed to the current operation.
virtual Dynamic::ExceptionList * exceptions (void)
virtual Dynamic::ContextList * contexts (void)
virtual Dynamic::RequestContext * operation_context (void)
virtual CORBA::Any * result (void)
virtual CORBA::Boolean response_expected (void)
 Returns true for a two-way operation, and false otherwise.
virtual Messaging::SyncScope sync_scope (void)
virtual
PortableInterceptor::ReplyStatus 
reply_status (void)
 Return the reply status for the current request.
virtual CORBA::Object_ptr forward_reference (void)
virtual CORBA::Any * get_slot (PortableInterceptor::SlotId id)
 Retrieve data from the "request scope" PICurrent object.
virtual IOP::ServiceContext * get_request_service_context (IOP::ServiceId id)
virtual IOP::ServiceContext * get_reply_service_context (IOP::ServiceId id)
virtual CORBA::Any * sending_exception (void)
virtual
PortableInterceptor::ObjectId * 
object_id (void)
 Return the ObjectId for the target object.
virtual CORBA::OctetSeq * adapter_id (void)
virtual char * server_id (void)
virtual char * orb_id (void)
virtual
PortableInterceptor::AdapterName * 
adapter_name (void)
virtual char * target_most_derived_interface (void)
 Return the most derived interface of the target object.
virtual CORBA::Policy_ptr get_server_policy (CORBA::PolicyType type)
virtual void set_slot (PortableInterceptor::SlotId id, const CORBA::Any &data)
 Insert data into the "request scope" PICurrent object.
virtual CORBA::Boolean target_is_a (const char *id)
virtual void add_reply_service_context (const IOP::ServiceContext &service_context, CORBA::Boolean replace)
TAO_ServerRequestserver_request (void)
Helper methods specific to TAO.
void forward_reference (PortableInterceptor::ForwardRequest &exc)
void forward_reference (CORBA::Object_ptr obj)

Protected Member Functions

IOP::ServiceContext * get_service_context_i (TAO_Service_Context &service_context_list, IOP::ServiceId id)

Protected Attributes

TAO_ServerRequestserver_request_
TAO::Argument *const *const args_
 Operation argument list.
size_t const nargs_
 Number of element in the operation argument list.
TAO::Portable_Server::Servant_Upcall
*const 
servant_upcall_
CORBA::TypeCode_ptr const *const exceptions_
CORBA::ULong const nexceptions_
 The number of elements in the exceptions_ array.


Detailed Description

Implementation of the PortableInterceptor::ServerRequestInfo IDL interface.

Implementation of the PortableInterceptor::ServerRequestInfo IDL interface.

Note:
This class is currently not meant to be reference counted since it is instantiated on the stack.

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TAO::ServerRequestInfo::ServerRequestInfo ( TAO_ServerRequest server_request,
TAO::Argument *const *  args,
size_t  nargs,
void *  servant_upcall,
CORBA::TypeCode_ptr const *  exceptions,
CORBA::ULong  nexceptions 
)

Constructor.


Member Function Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL CORBA::ULong TAO::ServerRequestInfo::request_id ( void   )  [virtual]

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

char * TAO::ServerRequestInfo::operation ( void   )  [virtual]

Return the operation name for the current request.

Dynamic::ParameterList * TAO::ServerRequestInfo::arguments ( void   )  [virtual]

Return the list of arguments passed to the current operation.

Dynamic::ExceptionList * TAO::ServerRequestInfo::exceptions ( void   )  [virtual]

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

Dynamic::ContextList * TAO::ServerRequestInfo::contexts ( void   )  [virtual]

Dynamic::RequestContext * TAO::ServerRequestInfo::operation_context ( void   )  [virtual]

CORBA::Any * TAO::ServerRequestInfo::result ( void   )  [virtual]

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

CORBA::Boolean TAO::ServerRequestInfo::response_expected ( void   )  [virtual]

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

Messaging::SyncScope TAO::ServerRequestInfo::sync_scope ( void   )  [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.

PortableInterceptor::ReplyStatus TAO::ServerRequestInfo::reply_status ( void   )  [virtual]

Return the reply status for the current request.

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

CORBA::Object_ptr TAO::ServerRequestInfo::forward_reference ( void   )  [virtual]

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

CORBA::Any * TAO::ServerRequestInfo::get_slot ( PortableInterceptor::SlotId  id  )  [virtual]

Retrieve data from the "request scope" PICurrent object.

IOP::ServiceContext * TAO::ServerRequestInfo::get_request_service_context ( IOP::ServiceId  id  )  [virtual]

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

IOP::ServiceContext * TAO::ServerRequestInfo::get_reply_service_context ( IOP::ServiceId  id  )  [virtual]

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

CORBA::Any * TAO::ServerRequestInfo::sending_exception ( void   )  [virtual]

Return an Any containing the exception being sent, if any. Otherwise, throw a CORBA::BAD_INV_ORDER exception.

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

PortableInterceptor::ObjectId * TAO::ServerRequestInfo::object_id ( void   )  [virtual]

Return the ObjectId for the target object.

CORBA::OctetSeq * TAO::ServerRequestInfo::adapter_id ( void   )  [virtual]

Return the AdapterId for the POA handling the current request.

char * TAO::ServerRequestInfo::server_id ( void   )  [virtual]

Return the server_id of the server. The value is passed to the ORB via -ORBServerId parameter.

char * TAO::ServerRequestInfo::orb_id ( void   )  [virtual]

Return the ORBId value that is passed to the ORB_init call.

PortableInterceptor::AdapterName * TAO::ServerRequestInfo::adapter_name ( void   )  [virtual]

Return the name of the object adapter that services requests for the invoked object.

char * TAO::ServerRequestInfo::target_most_derived_interface ( void   )  [virtual]

Return the most derived interface of the target object.

CORBA::Policy_ptr TAO::ServerRequestInfo::get_server_policy ( CORBA::PolicyType  type  )  [virtual]

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

void TAO::ServerRequestInfo::set_slot ( PortableInterceptor::SlotId  id,
const CORBA::Any &  data 
) [virtual]

Insert data into the "request scope" PICurrent object.

CORBA::Boolean TAO::ServerRequestInfo::target_is_a ( const char *  id  )  [virtual]

Returns true if the target's type corresponds to the given RepositoryId.

void TAO::ServerRequestInfo::add_reply_service_context ( const IOP::ServiceContext &  service_context,
CORBA::Boolean  replace 
) [virtual]

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

ACE_INLINE void TAO::ServerRequestInfo::forward_reference ( PortableInterceptor::ForwardRequest &  exc  ) 

Extract the forward object reference from the PortableInterceptor::ForwardRequest exception, and set the reply status flag accordingly.

ACE_INLINE void TAO::ServerRequestInfo::forward_reference ( CORBA::Object_ptr  obj  ) 

Set the forward reference associated with the current LOCATION_FORWARD reply.

Note:
This method is only invoked when a PortableServer::ForwardRequest exception is thrown by a servant manager.

ACE_INLINE TAO_ServerRequest & TAO::ServerRequestInfo::server_request ( void   ) 

Return a reference to the underlying TAO_ServerRequest object.

IOP::ServiceContext * TAO::ServerRequestInfo::get_service_context_i ( TAO_Service_Context service_context_list,
IOP::ServiceId  id 
) [protected]

Helper method to get the request and response service contexts.


Member Data Documentation

TAO_ServerRequest& TAO::ServerRequestInfo::server_request_ [protected]

Underlying request object that contains much of the information encapsulated by this ServerRequestInfo implementation.

TAO::Argument* const* const TAO::ServerRequestInfo::args_ [protected]

Operation argument list.

size_t const TAO::ServerRequestInfo::nargs_ [protected]

Number of element in the operation argument list.

TAO::Portable_Server::Servant_Upcall* const TAO::ServerRequestInfo::servant_upcall_ [protected]

Pointer to the Servant_Upcall object that contains the object ID, among other things.

CORBA::TypeCode_ptr const* const TAO::ServerRequestInfo::exceptions_ [protected]

Array of TypeCodes for user exceptions the operation is capable of raising.

CORBA::ULong const TAO::ServerRequestInfo::nexceptions_ [protected]

The number of elements in the exceptions_ array.


The documentation for this class was generated from the following files:
Generated on Fri Dec 14 03:57:11 2007 for TAO_PI_Server by  doxygen 1.5.3-6