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

#include <FILE.h>

Inheritance diagram for ACE_FILE:

[legend]

Collaboration diagram for ACE_FILE:

[legend]

Public Member Functions
int	close ()
int	remove ()
	Close and remove the ACE_FILE from the file system.
int	unlink ()
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 ()
	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 () const
	Dump the state of an object.
Public Member Functions inherited from ACE_IO_SAP
	~ACE_IO_SAP ()
	Default dtor.
int	control (int cmd, void *) const
	Interface for ioctl.
int	enable (int value) const
int	disable (int value) const
ACE_HANDLE	get_handle () const
	Get the underlying handle.
void	set_handle (ACE_HANDLE handle)
	Set the underlying handle.
void	dump () const
	Dump the state of an object.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Public Attributes inherited from ACE_IO_SAP
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Protected Member Functions
	ACE_FILE ()
Protected Member Functions inherited from ACE_IO_SAP
	ACE_IO_SAP ()
	Ensure that ACE_IO_SAP is an abstract base class.

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

Additional Inherited Members
Public Types inherited from ACE_IO_SAP
enum	{ INVALID_HANDLE = -1 }

Detailed Description

Defines the core methods of the ACE_FILE abstraction.

Constructor & Destructor Documentation

◆ ACE_FILE()

ACE_FILE::ACE_FILE ( )

protected

Ensure that this class is only created by the ACE_FILE_Connector.

Member Function Documentation

◆ close()

int ACE_FILE::close ( )

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

◆ disable()

int ACE_FILE::disable ( int signum ) const

inline

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

◆ dump()

void ACE_FILE::dump ( ) const

Dump the state of an object.

◆ get_info() [1/2]

int ACE_FILE::get_info ( ACE_FILE_Info & finfo )

Get information on this ACE_FILE.

◆ get_info() [2/2]

int ACE_FILE::get_info ( ACE_FILE_Info * finfo )

Get information on this ACE_FILE.

◆ get_local_addr()

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.

◆ get_remote_addr()

int ACE_FILE::get_remote_addr ( ACE_Addr & addr ) const

Return the same thing as get_local_addr().

◆ remove()

int ACE_FILE::remove ( )

Close and remove the ACE_FILE from the file system.

◆ seek()

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.

◆ tell()

ACE_OFF_T ACE_FILE::tell ( )

Return an offset for the file handle.

◆ truncate()

int ACE_FILE::truncate ( ACE_OFF_T length )

Set filesize to length byte.

◆ unlink()

int ACE_FILE::unlink ( )

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

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

ACE_FILE::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ addr_

ACE_FILE_Addr ACE_FILE::addr_