diff options
Diffstat (limited to 'TAO/tao/iiopobj.h')
| -rw-r--r-- | TAO/tao/iiopobj.h | 253 |
1 files changed, 253 insertions, 0 deletions
diff --git a/TAO/tao/iiopobj.h b/TAO/tao/iiopobj.h new file mode 100644 index 00000000000..0495e2f040a --- /dev/null +++ b/TAO/tao/iiopobj.h @@ -0,0 +1,253 @@ +// This may look like C, but it's really -*- C++ -*- +// $Id$ + +// ============================================================================ +// +// = LIBRARY +// TAO +// +// = FILENAME +// iiopobj.h +// +// = DESCRIPTION +// IIOP objref representation +// +// This allows stubs which support multiple protocols, since the +// stub (and DII) code only work with the parent "STUB_Objref" +// class when making calls. +// +// = AUTHOR +// Copyright 1994-1995 by Sun Microsystems Inc. +// +// ============================================================================ + +#if !defined (TAO_IIOPOBJ_H) +# define TAO_IIOPOBJ_H + +class TAO_Export IIOP + // = TITLE + // This class provides a namespace. +{ +public: + // IIOP Protocol version is distinct from GIOP version. + enum + { + MY_MAJOR = 1, + MY_MINOR = 0 + }; + + struct Version + { + CORBA::Octet major; + CORBA::Octet minor; + + Version (CORBA::Octet maj = MY_MAJOR, + CORBA::Octet min = MY_MINOR); + }; + + struct Profile + // = TITLE + // IOR support ... Profile is encapsulated in an IIOP profile + // entry within an IOR. Note that this structure is specified + // by CORBA 2.0, so we can't screw with it too much. + { + Version iiop_version; + TAO_opaque object_key; + char *host; + CORBA::UShort port; + + Profile (void); + // Default constructor. + + Profile (const Profile &src); + // Copy constructor. + + Profile (const char *host, + const CORBA::UShort port, + const char *object_key); + // Called by client <_bind>. + + Profile (const char *host, + const CORBA::UShort port, + const char *object_key, + const ACE_INET_Addr &addr); + // Called by server. + + Profile (const ACE_INET_Addr &addr, + const char *object_key); + // Called by client or server. + + Profile (const ACE_INET_Addr &addr, + const TAO_opaque &object_key); + // Called by client or server. + + ~Profile (void); + // Destructor. + + void object_addr (const ACE_INET_Addr *); + // Sets <object_addr_> cache from <host> and <port> + + ACE_INET_Addr &object_addr (void); + // Returns the <ACE_INET_Addr> for this profile. + + private: + int set (const char *host, + const CORBA::UShort port, + const ACE_INET_Addr *addr); + // Internal helper method (called by the next two methods). + + int set (const char *host, + const CORBA::UShort port, + const char *object_key, + const ACE_INET_Addr *addr = 0); + // Called by server. + + int set (const char *host, + const CORBA::UShort port, + const TAO_opaque &object_key, + const ACE_INET_Addr *addr = 0); + // Called by server. + + int set (const ACE_INET_Addr &addr, + const char *object_key); + // Called by client or server. + + int set (const ACE_INET_Addr &addr, + const TAO_opaque &object_key); + // Called by client or server. + + Profile &operator = (const Profile &src); + // Disallow copy constructor. + + ACE_INET_Addr object_addr_; + // Cached instance of <ACE_INET_Addr> for use in making + // invocations, etc. + }; +}; + +class TAO_Export IIOP_Object : public STUB_Object + // = TITLE + // Representation of an IIOP objref: the profile body, and any + // forwarded pointer. Implementations of basic invocation code; + // how to marshal an objref. Contains a CORBA::Object interface. + // + // = DESCRIPTION + // NOTE that this uses (single) implementation inheritance to share + // most of the basic code for an object reference. +{ +public: + void do_call (CORBA::Environment &env, + const TAO_Call_Data *info, + ...); + // SII-based invocation. + + void do_dynamic_call (const char *opname, + CORBA::Boolean is_roundtrip, + CORBA::NVList_ptr args, + CORBA::NamedValue_ptr result, + CORBA::Flags flags, + CORBA::ExceptionList &exceptions, + CORBA::Environment &env); + // DII-based invocation. + + // = Support for tables keyed by objrefs. + + CORBA::ULong hash (CORBA::ULong maximum, + CORBA::Environment &env); + CORBA::Boolean is_equivalent (CORBA::Object_ptr other_obj, + CORBA::Environment &env); + // XXX All objref representations should know how to marshal + // themselves. That will involve ensuring that the IOR that gets + // marshaled talks a specific protocol, otherwise the target of a + // message would not be invoke using the objref it receives + // (compromising functionality in a very basic and mysterious + // mannter). So for example an objref might need to create a proxy + // for itself rather than marshaling its own representation. [ The + // IIOP engine does not need to worry about such issues since it + // only supports one protocol -- the problem won't show up. + // "Multiprotocol ORBs" will need to solve that problem though. ] + + // = Thread-safe accessors for the forwarding profile + IIOP::Profile *fwd_profile (void); + // THREAD-SAFE. Returns the current forwarding profile. + + IIOP::Profile *fwd_profile (IIOP::Profile *new_profile); + // THREAD-SAFE. Sets a new value for the forwarding profile and + // returns the current value. + + // = Non-thread-safe accessors for the forwarding profile + ACE_SYNCH_MUTEX &fwd_profile_lock (void); + // Gives reference to the lock guarding the forwarding profile. + + IIOP::Profile *fwd_profile_i (void); + // THREAD-SAFE. Returns the current forwarding profile. + + IIOP::Profile *fwd_profile_i (IIOP::Profile *new_profile); + // THREAD-SAFE. Sets a new value for the forwarding profile and + // returns the current value. + + // = Construction + IIOP_Object (char *repository_id); + // Construct from a repository (type) ID. + + IIOP_Object (char *repository_id, + const IIOP::Profile &profile); + // Construct from a repository ID and a profile ID. + + IIOP_Object (const char *host = ACE_DEFAULT_SERVER_HOST, + const CORBA::UShort p = TAO_DEFAULT_SERVER_PORT, + const char *objkey = "0", // @@ (IRFAN) We may need to remove this def arg + char *repository_id = 0); + // This constructor will usually be used by a <_bind> call on the + // client side. + + IIOP_Object (char *repository_id, + const ACE_INET_Addr &addr, + const char *objkey /*= "0"*/); // @@ (IRFAN) We may need to remove this def arg + // Constructor used typically by the server side. + + // = COM stuff + ULONG AddRef (void); + ULONG Release (void); + TAO_HRESULT QueryInterface (REFIID type_id, + void **ppv); + + virtual TAO_ObjectKey *key (CORBA::Environment &env); + // Return the object key as an out parameter. Caller should release + // return value when finished with it. + + IIOP::Profile profile; + // Profile for this object. + +private: + ACE_SYNCH_MUTEX IUnknown_lock_; + // Mutex to protect <IUnknown>-related stuff. + + u_int refcount_; + // Number of outstanding references to this object. + + ACE_SYNCH_MUTEX fwd_profile_lock_; + // This lock covers the mutable info in all IIOP objref data, + // namely the forwarded-to objref. It must be held when a client + // thread is reading or modifying that data, to prevent one from + // overwriting data the other's reading or writing. + + IIOP::Profile *fwd_profile_; + // This is a pointer to a profile used if the object is not + // collocated in the current process. + + ~IIOP_Object (void); + // Destructor is to be called only through Release() + + // = Disallow copy constructor and assignment operator + ACE_UNIMPLEMENTED_FUNC (IIOP_Object (const IIOP_Object &)) + ACE_UNIMPLEMENTED_FUNC (IIOP_Object &operator = (const IIOP_Object &)) + +#if defined (__GNUG__) + // G++ (even 2.6.3) stupidly thinks instances can't be created. + // This de-warns. + friend class everyone_needs_a_friend; +#endif /* __GNUG__ */ +}; + +#endif /* TAO_IIOPOBJ_H */ |