ACE_FILE Class Reference

Defines the core methods of the ACE_FILE abstraction. More...

#include <FILE.h>

Inheritance diagram for ACE_FILE:

Inheritance graph
[legend]
Collaboration diagram for ACE_FILE:

Collaboration graph
[legend]

List of all members.

Public Member Functions

int close (void)
int remove (void)
 Close and remove the ACE_FILE from the file system.
int unlink (void)
int get_info (ACE_FILE_Info *finfo)
 Get information on this ACE_FILE.
int get_info (ACE_FILE_Info &finfo)
 Get information on this ACE_FILE.
int truncate (ACE_OFF_T length)
 Set filesize to length byte.
ACE_OFF_T seek (ACE_OFF_T offset, int whence=SEEK_CUR)
ACE_OFF_T tell (void)
 Return an offset for the file handle.
int disable (int signum) const
int get_local_addr (ACE_Addr &) const
int get_remote_addr (ACE_Addr &) const
 Return the same thing as get_local_addr().
void dump (void) const
 Dump the state of an object.

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.

Protected Member Functions

 ACE_FILE (void)

Protected Attributes

ACE_FILE_Addr addr_
 File we are "connected" with...


Detailed Description

Defines the core methods of the ACE_FILE abstraction.

Constructor & Destructor Documentation

ACE_FILE::ACE_FILE ( void   )  [protected]

Ensure that this class is only created by the ACE_FILE_Connector.


Member Function Documentation

int ACE_FILE::close ( void   ) 

Close the ACE_FILE handle without removing the ACE_FILE from the file system.

int ACE_FILE::remove ( void   ) 

Close and remove the ACE_FILE from the file system.

int ACE_FILE::unlink ( void   ) 

Remove the ACE_FILE from the file system without closing the ACE_FILE handle.

int ACE_FILE::get_info ( ACE_FILE_Info finfo  ) 

Get information on this ACE_FILE.

int ACE_FILE::get_info ( ACE_FILE_Info finfo  ) 

Get information on this ACE_FILE.

int ACE_FILE::truncate ( ACE_OFF_T  length  ) 

Set filesize to length byte.

ACE_OFF_T ACE_FILE::seek ( ACE_OFF_T  offset,
int  whence = SEEK_CUR 
)

Sets the file pointer as follows: o If <whence> is <SEEK_SET>, the pointer is set to offset bytes.

o If <whence> is <SEEK_CUR>, the pointer is set to its current location plus offset.

o If <whence> is <SEEK_END>, the pointer is set to the size of the file plus offset.

ACE_OFF_T ACE_FILE::tell ( void   ) 

Return an offset for the file handle.

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int ACE_FILE::disable ( int  signum  )  const

Disable signal signum This is here to prevent Win32 from disabling SPIPE using socket calls

Reimplemented from ACE_IO_SAP.

int ACE_FILE::get_local_addr ( ACE_Addr addr  )  const

Return the local endpoint address in the referenced ACE_Addr. Returns 0 if successful, else -1.

int ACE_FILE::get_remote_addr ( ACE_Addr addr  )  const

Return the same thing as get_local_addr().

ACE_BEGIN_VERSIONED_NAMESPACE_DECL void ACE_FILE::dump ( void   )  const

Dump the state of an object.

Reimplemented from ACE_IO_SAP.

Reimplemented in ACE_FILE_IO.


Member Data Documentation

Declare the dynamic allocation hooks.

Reimplemented from ACE_IO_SAP.

Reimplemented in ACE_FILE_IO.

File we are "connected" with...


The documentation for this class was generated from the following files:

Generated on Wed Apr 23 02:39:06 2008 for ACE by  doxygen 1.5.5