diff options
Diffstat (limited to 'tests/POA/Default_Servant2/File_i.h')
-rw-r--r-- | tests/POA/Default_Servant2/File_i.h | 85 |
1 files changed, 47 insertions, 38 deletions
diff --git a/tests/POA/Default_Servant2/File_i.h b/tests/POA/Default_Servant2/File_i.h index 5c5de0a4da4..96238ca075e 100644 --- a/tests/POA/Default_Servant2/File_i.h +++ b/tests/POA/Default_Servant2/File_i.h @@ -1,82 +1,91 @@ -// $Id$ - -//=================================================================== -// -// = FILENAME -// File_i.h -// -// = DESCRIPTION -// Defines the implementation classes for the File IDL -// module -// -// = AUTHOR -// Irfan Pyarali -// -//==================================================================== + +//============================================================================= +/** + * @file File_i.h + * + * $Id$ + * + * Defines the implementation classes for the File IDL + * module + * + * + * @author Irfan Pyarali + */ +//============================================================================= + #include "FileS.h" +/** + * @class FileImpl + * + * @brief FileImpl class provides the namespace for the File IDL module . + */ class FileImpl { - // = TITLE - // FileImpl class provides the namespace for the File IDL module . public: + /** + * @class Descriptor + * + * @brief Descriptor implements the Descriptor interface in the File + * Module A single Descriptor servant can serve multiple object + * references + */ class Descriptor : public POA_File::Descriptor { - // = TITLE - // Descriptor implements the Descriptor interface in the File - // Module A single Descriptor servant can serve multiple object - // references public: + /// Constructor Descriptor (PortableServer::POA_ptr poa); - // Constructor + /// Destructor ~Descriptor (void); - // Destructor + /// Returns the default POA of this object PortableServer::POA_ptr _default_POA (void); - // Returns the default POA of this object + /// write buffer to File corresponding to this Descriptor virtual CORBA::Long write (const File::Descriptor::DataBuffer &buffer); - // write buffer to File corresponding to this Descriptor virtual File::Descriptor::DataBuffer *read (CORBA::Long num_bytes); + /// seek to the offset in file from whence virtual CORBA::ULong lseek (CORBA::ULong offset, CORBA::Long whence); - // seek to the offset in file from whence + /// closes the file corresponding to the requested ObjectID virtual void destroy (void); - // closes the file corresponding to the requested ObjectID private: + /// Extracts the ACE_HANDLE from the objectID ACE_HANDLE fd (void); - // Extracts the ACE_HANDLE from the objectID PortableServer::POA_var poa_; }; + /** + * @class System + * + * @brief File System implementation class. + */ class System : public POA_File::System { - // = TITLE - // File System implementation class. public: + /// Constructor, Creates a single File Descriptor Servant and + /// registers it with the POA as the Default Servant System (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa); - // Constructor, Creates a single File Descriptor Servant and - // registers it with the POA as the Default Servant + ///Destructor ~System (void); - //Destructor + ///Returns the default POA of this object PortableServer::POA_ptr _default_POA (void); - //Returns the default POA of this object + /// Opens a file ,creates a Descriptor reference with the + /// ACE_HANDLE and returns that reference File::Descriptor_ptr open (const char *file_name, CORBA::Long flags); - // Opens a file ,creates a Descriptor reference with the - // ACE_HANDLE and returns that reference void shutdown (void); private: @@ -84,8 +93,8 @@ public: PortableServer::POA_var poa_; + /// The single File Descriptor servant which serves requests for + /// any Descriptor object under poa_. Descriptor fd_servant_; - // The single File Descriptor servant which serves requests for - // any Descriptor object under poa_. }; }; |